> ## 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-Hans/quickstart">
    注册、获取 API key,并在两分钟内查询第一个 schema。
  </Card>

  <Card title="Hermai 如何运作" icon="wand-magic-sparkles" href="/zh-Hans/concepts/how-hermai-works">
    心智模型:贡献者负责发现,agent 负责使用。
  </Card>

  <Card title="Schemas" icon="database" href="/zh-Hans/concepts/schemas">
    什么是 schema、如何贡献,以及认证徽章制度。
  </Card>

  <Card title="Catalog" icon="compass" href="/zh-Hans/concepts/catalog">
    agent 在运行时调用的查询 API。
  </Card>

  <Card title="Hosted fetch" icon="cloud" href="/zh-Hans/concepts/hosted-fetch">
    通过 Hermai 运行已注册端点。
  </Card>

  <Card title="Actions" icon="hand-pointer" href="/zh-Hans/concepts/actions">
    schema 提供的读取和写入动作。
  </Card>

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

  <Card title="API keys" icon="key" href="/zh-Hans/concepts/api-keys">
    验证请求并管理访问权限。
  </Card>
</CardGroup>

## 开源

[hermai-cli](https://github.com/hermai-ai/hermai-cli) 以 AGPL-3.0 开源。你可以在本地运行发现工具,无需注册账号。平台 registry 在此基础上提供浏览、搜索和 hosted fetch。