mcpField
S
strapi-docs-mcp

strapi-docs-mcp

github.com/strapi开发9288 次安装14 周前更新
代码仓库

关于 strapi-docs-mcp

strapi-docs-mcp 是 Strapi 文档的远程 MCP 服务,为客户端提供指南、API 参考和代码示例,便于基于当前文档回答 Strapi 问题。

主要功能

  1. 01提供 Strapi 指南与 API 文档
  2. 02检索文档中的代码示例
  3. 03支持 OAuth 连接
  4. 04提示引用文档链接

适用场景

  1. 01查询 Strapi API 用法
  2. 02查找配置与代码示例
  3. 03基于文档回答 Strapi 开发问题
  4. 04在 MCP 不可用时查阅 Markdown 文档

MCP 相关

它通过远程 MCP 服务向客户端提供 Strapi 文档内容。连接地址为 https://strapi-docs.mcp.kapa.ai,首次连接需完成 OAuth 授权。

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/strapi/skills --skill strapi-docs-mcp

安装后在 Claude Code 中输入/strapi-docs-mcp确认已加载。

详细介绍

Strapi 文档 MCP 服务

strapi-docs MCP 服务(URL:https://strapi-docs.mcp.kapa.ai)提供完整的 Strapi 文档(指南、API 参考和代码示例)。回答 Strapi 相关问题时,优先使用该服务,而非可能已经过时的训练数据。

权威来源:https://docs.strapi.io/cms/ai/docs-mcp-server

第 1 步 — 检查是否可用

检查当前环境中是否已连接 strapi-docs MCP 服务 / 工具。

  • 可用 → 转到 使用它。
  • 不可用 → 转到 安装它。

可用:使用它

调用 strapi-docs MCP 工具回答 Strapi 相关问题。直接传入用户的问题;准确引用返回的 API 名称、配置键和版本。在回答中引用文档链接。

不可用:安装它

将名为 strapi-docs 的远程 HTTP MCP 服务(URL https://strapi-docs.mcp.kapa.ai)添加到宿主工具的 MCP 配置中,并使用其标准格式。该服务使用 OAuth——用户首次连接时需完成授权流程。然后让用户重新加载 / 重启,以连接该服务。

各工具的配置格式:https://docs.strapi.io/cms/ai/docs-mcp-server#connection-details

最后手段:直接查询文档内容

如果 MCP 服务不可用且无法安装,可改用公开的文档内容。这些资源均无需身份验证。请按以下顺序优先使用。

1. 单页 Markdown(最简单——在任意页面 URL 后添加 .md)

在任意文档页面 URL 后添加 .md,即可获取纯 Markdown 格式的页面内容。所有布局组件(标签页、折叠面板、API 内容块)都会转换为纯文本,因此不会遗漏隐藏内容。

  • 页面 URL: https://docs.strapi.io/cms/backend-customization/controllers
  • Markdown URL:https://docs.strapi.io/cms/backend-customization/controllers.md
  • 格式:在任意 https://docs.strapi.io/<page-path> 后添加 .md

这与文档站点的 复制 Markdown 按钮使用的内容相同。

2. LLM 文本文件(一次需要多个页面时的最佳选择——纯文本,无隐藏内容)

这些文件遵循 llms.txt 约定,是最适合 Agent 使用的来源:内容已转换为纯 Markdown,因此标签页或折叠面板中不会隐藏任何内容。

文件URL用途
索引https://docs.strapi.io/llms.txt查找所有页面:包含所有页面链接及其单行摘要的列表。
完整内容https://docs.strapi.io/llms-full.txt完整文档,集中在一个文件中。获取一次后即可搜索 / grep。
仅代码https://docs.strapi.io/llms-code.txt按页面分组的所有代码示例。

**从 llms.txt 构造页面 URL:**条目是以协议相对路径表示的,例如 //cms/backend-customization/controllers。在前面添加文档站点的源地址,即可获得有效页面 URL:

//cms/backend-customization/controllers 变为 https://docs.strapi.io/cms/backend-customization/controllers

3. GitHub 上的原始 Markdown 源文件(单页、权威)

每个页面都是 strapi/documentation 中的 .md / .mdx 文件。仅当 docs.strapi.io 本身无法访问时,才使用此方式。根据页面路径构造原始文件 URL:

  • 页面路径: /cms/backend-customization/controllers
  • 原始 URL:https://raw.githubusercontent.com/strapi/documentation/main/docusaurus/docs/cms/backend-customization/controllers.md
  • 格式: https://raw.githubusercontent.com/strapi/documentation/main/docusaurus/docs/<page-path>.md 其中 <page-path> 是页面 URL 路径(去掉开头的 /)。部分页面使用 .mdx——如果 .md 返回 404,请改用 .mdx 重试。
4. 实时 HTML 页面(最后手段)

直接获取页面,例如 https://docs.strapi.io/cms/backend-customization/controllers,并提取内容。此方式最不可靠:部分内容位于标签页 / 折叠面板中,可能会遗漏。请尽可能优先使用来源 1 至 3。

评论

支持 Markdown