子比主题开发文档
使用指南Codestar Framework主题扩展WP AI开发工具社区协作赞助打赏

MCP 服务器

在 Codex、Claude Code、Cursor 和 VS Code 中通过本地 stdio 接入本站文档。

MCP(Model Context Protocol)让 AI 客户端按需读取外部资料和工具。本站采用本地 stdio 方案:网站是纯静态 Fumadocs 文档站,MCP 服务器作为独立 npm 包运行,不需要网站端口、数据库、Redis、登录或环境变量。

什么时候使用 MCP

  • 你希望 AI 按本站文档回答,而不是凭通用知识猜测。
  • 你正在写子主题、插件、Codestar 配置或主题接口。
  • 你想搜索 Zibpay、Ajax、Hook、Meta、商城、论坛或主题扩展资料。
  • 你希望在本地编辑器里持续使用文档上下文,同时让网站承受大量静态访问。

快速接入

纯静态文档站
网站只发布 Fumadocs 静态文件,不运行 AI、登录、数据库或 MCP HTTP 服务。
本地按需启动
AI 客户端需要资料时才启动本地 `stdio` MCP 进程,读取公开文档资源。
无密钥配置
文档随插件包发布,不需要数据库、环境变量、Redis 或网站账号。
Codex 插件
插件会同时安装 Skill 和本地 stdio MCP 配置。
codex plugin marketplace add https://github.com/DearLicy/zibll-docs.git && codex plugin add zibll-docs@zibll-docs

按需安装专业插件:

codex plugin add zibll-theme-dev@zibll-docs
codex plugin add zibll-wp-ai-dev@zibll-docs
codex plugin add zibll-migration-helper@zibll-docs

只接入 MCP 时,把下面配置放入 Codex 配置文件:

[mcp_servers.zibll-docs]
command = "npx"
args = ["-y", "zibll-docs-mcp"]
可直接尝试的提示词
连接完成后,让 AI 先检索本站文档,再结合你的主题或插件源码工作。
  • 先搜索本站关于 Codestar 自定义字段的文档,再给出文章 Meta 示例。
  • 读取 Zibpay 付费下载资料,列出开发时需要保留的权限检查。
  • 结合我的子主题源码,判断新功能应该放在插件还是子主题中。
  • 结合源码和文档,列出一次主题扩展的核对顺序。
可用工具
MCP 包提供文档列表、单页读取、关键词检索、相关文档包、大纲和代码示例查询。

服务器能力

独立 MCP 包提供八个只读工具:

  • list_docs:列出全部公开文档。
  • read_doc:按 slug 读取单篇文档,例如 codestar-frameworkapi/functionscommunity/github-community
  • search_docs:搜索标题、描述和 Markdown 正文。
  • read_docs_bundle:按关键词读取少量相关页面。
  • doc_outline:查看页面标题大纲。
  • find_code_examples:查找文档中的代码块、命令和配置示例。
  • list_source_files:列出用户通过 --source-dir 主动挂载的本地源码文件。
  • read_source_file:读取挂载目录内的单个源码文件,并阻止目录穿越、敏感文件和超大文件。

同时提供 zibll-docs://docs/{slug} 只读资源 URI。文档首页使用 zibll-docs://docs/index

文档和源码的边界

MCP 默认只读取随包发布的本站文档。需要参考你自己的子比主题、子主题或插件时,可以把目录交给 Codex 作为工作区,或显式挂载给 MCP:

npx -y zibll-docs-mcp --source-dir /path/to/主题插件子主题

只有显式挂载后,list_source_filesread_source_file 才可用。插件和 MCP 不会编辑、上传或持久化这些文件,也不能读取挂载目录之外的路径。

更新方式

文档更新后发布新的 zibll-docs-mcp 版本,或在仓库源码目录重新运行本地包。MCP 进程由客户端按需拉起,未使用时不会在网站服务器上常驻。

相关入口

  • Codex 插件:安装 Skill 与 MCP 配置。
  • Skill 文档:了解任务规则和推荐阅读顺序。
  • LLM 文本:给不支持 MCP 的工具使用纯文本索引和单页 Markdown。

这篇文档对您有帮助吗?

本页目录