EmDash 文档 MCP

本页内容

EmDash 文档站点在 https://docs.emdashcms.com/mcp 提供一个公共 Model Context Protocol 服务器。连接编码助手,在工作时搜索已发布的文档。

这与你站点的 MCP 服务器是分开的(在 AI 工具指南中介绍)。文档 MCP 只了解 EmDash 的文档——它无法读取或修改你的内容。连接文档 MCP 用于文档查找,连接站点 MCP 用于内容管理,或在助手需要两种访问时同时连接两者。

功能

文档 MCP 提供一个工具:

工具用途
search_docs搜索 EmDash 文档。返回带有来源 URL 和匹配分数的相关片段。

服务器在 docs.emdashcms.com 的索引上使用 Cloudflare AI Search。结果包含来源 URL 和匹配段落;AI 客户端决定如何在其回答中使用它们。

连接

服务器可在以下端点访问,无需身份验证或 API 密钥。它是公开的且只读的。

https://docs.emdashcms.com/mcp

EmDash 模板中的自动发现

如果你从 EmDash 模板(npm create emdash)启动项目,三个配置文件已经就位,会自动被检测到:

文件使用者
.mcp.jsonClaude Code
.cursor/mcp.jsonCursor
.vscode/mcp.jsonVS Code

打开项目并接受工具首次运行时显示的工作区信任提示。无需进一步设置。

手动设置

如果你没有使用模板,或使用不同的工具,用你的客户端对应的代码片段添加一次:

Codex

用 Codex CLI 添加公共远程服务器:

codex mcp add emdash-docs --url https://docs.emdashcms.com/mcp

ChatGPT 桌面应用、Codex CLI 和 IDE 扩展共享同一 Codex 主机的 MCP 配置。Codex 官方 MCP 文档涵盖 CLI、config.toml 和当前传输支持。

ChatGPT

ChatGPT 开发者模式可以从无需身份验证的远程 MCP 服务器创建应用。创建应用时使用文档 MCP 端点。请遵循 ChatGPT 开发者模式官方指南了解当前资格和控制,而非依赖复制的设置路径。

Claude Code

以下命令使用 Claude Code CLI 添加服务器:

claude mcp add --transport http emdash-docs https://docs.emdashcms.com/mcp

或者提交 EmDash 模板提供的相同 .mcp.json 文件:

{
  "mcpServers": {
    "emdash-docs": {
      "type": "http",
      "url": "https://docs.emdashcms.com/mcp"
    }
  }
}

OpenCode

opencode.jsonc 中添加以下条目:

{
  "mcp": {
    "emdash-docs": {
      "type": "remote",
      "url": "https://docs.emdashcms.com/mcp"
    }
  }
}

Cursor

在项目根目录提交一个包含以下内容的 .cursor/mcp.json 文件。用户级别或界面设置请遵循 Cursor 的 MCP 文档

{
  "mcpServers": {
    "emdash-docs": {
      "type": "http",
      "url": "https://docs.emdashcms.com/mcp"
    }
  }
}

VS Code

在项目的 .vscode/mcp.json 中添加以下条目。用户级配置和信任控制请遵循 Visual Studio Code 的 MCP 文档

{
  "servers": {
    "emdash-docs": {
      "type": "http",
      "url": "https://docs.emdashcms.com/mcp"
    }
  }
}

Claude

将端点添加为远程自定义连接器。连接器界面和计划要求由 Anthropic 控制,因此请遵循其当前远程 MCP 连接器说明

何时使用

  • 你正在构建 EmDash 站点,希望 AI 助手从当前文档中查找正确的 API、钩子名称或配置选项,而非依赖半记忆的训练数据。
  • 你正在编写插件,想了解哪些钩子按什么顺序触发。
  • 你正在移植 WordPress 主题,想要种子文件模式的示例。
  • 你遇到错误卡住了,想搜索发行说明和概念。

AGENTS.md 中推荐

如果你的项目使用 AGENTS.md(或 CLAUDE.md.cursorrules 等)来指导 AI 工具,将它们指向文档 MCP,使其优先使用真实文档而非猜测:

## 文档

需要验证 API、钩子、配置选项或模式时,通过 `emdash-docs` MCP 服务器查找
EmDash 文档。优先使用文档 MCP 而非训练数据的猜测——文档反映了当前已发布的
行为。

EmDash 入门模板已预装此代码片段。