> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hermai.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 介紹

> Hermai 是一個由社群驅動的網站 API schema registry。

Hermai 是一個 schema registry 和 hosted fetch API。查詢 registry 裡的網域,即可取得可呼叫端點清單: endpoint name、HTTP method、參數和回應形狀。你可以自行執行 schema,也可以對支援的端點呼叫 hosted fetch。

可以把它想成**網站 API 版本的 HuggingFace**。

## 運作方式

<CardGroup cols={2}>
  <Card title="用 CLI 貢獻" icon="terminal">
    使用探索工具組(`hermai detect`、`probe`、`extract`、`intercept`)記錄網站端點,然後執行 `hermai registry push` 將其新增到目錄。
  </Card>

  <Card title="從 registry 查詢" icon="magnifying-glass">
    呼叫 `GET /v1/catalog/{domain}` 取得該網站所有已知端點。社群貢獻的 schema 讓呼叫方複用既有探索工作。
  </Card>

  <Card title="Hosted fetch" icon="cloud">
    呼叫 `POST /v1/fetch`,讓 Hermai 替你執行支援的已註冊端點並回傳結構化結果。
  </Card>
</CardGroup>

<Tip>
  **在 Claude Code、Codex、Cursor 或其他 coding agent 裡使用?** 透過 `npx skills add hermai-ai/hermai-skills` 安裝 [Hermai skills](https://github.com/hermai-ai/hermai-skills),替它加入 Hermai registry 工作流。
</Tip>

## 從這裡開始

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/zh-Hant/quickstart">
    註冊、取得 API key,並在兩分鐘內查詢第一份 schema。
  </Card>

  <Card title="Hermai 如何運作" icon="wand-magic-sparkles" href="/zh-Hant/concepts/how-hermai-works">
    心智模型:貢獻者負責探索,agent 負責使用。
  </Card>

  <Card title="Schemas" icon="database" href="/zh-Hant/concepts/schemas">
    什麼是 schema、如何貢獻,以及認證徽章制度。
  </Card>

  <Card title="Catalog" icon="compass" href="/zh-Hant/concepts/catalog">
    agent 在執行期呼叫的查詢 API。
  </Card>

  <Card title="Hosted fetch" icon="cloud" href="/zh-Hant/concepts/hosted-fetch">
    透過 Hermai 執行已註冊端點。
  </Card>

  <Card title="Actions" icon="hand-pointer" href="/zh-Hant/concepts/actions">
    schema 提供的讀取與寫入動作。
  </Card>

  <Card title="MCP server" icon="plug" href="/zh-Hant/concepts/mcp">
    把 Hermai schema 暴露為本地 MCP tools。
  </Card>

  <Card title="API keys" icon="key" href="/zh-Hant/concepts/api-keys">
    驗證請求並管理存取權限。
  </Card>
</CardGroup>

## 開源

[hermai-cli](https://github.com/hermai-ai/hermai-cli) 以 AGPL-3.0 授權開源。你可以在本機執行探索工具,不需要註冊帳號。平台 registry 在此基礎上提供瀏覽、搜尋和 hosted fetch。