microCMS 文档 MCP 服务器
使用说明内容(Markdown格式)
项目简介
该项目实现了一个基于 MCP 的服务器端后端,为大语言模型(LLM)客户端提供对 microCMS 文档的访问、检索与工具调用能力,核心通过 MCP 协议的工具接口实现对本地文档资源的管理与查询。
主要功能点
- 提供 MCP 的工具接口,支持 fetch_general、list_documents、search_document 三类工具。
- 通过访问本地 docs 目录,读取并返回文档信息和内容,支持按类别检索。
- 返回结构符合 MCP 规范的文本内容形式,便于 LLM 将结果整合进对话上下文。
- 使用 StdioServerTransport 实现与 MCP 客户端的通信,便于在本地或管道式环境中运行。
- 错误处理遵循 MCP 的错误码规范,确保客户端能够正确解析异常信息。
安装步骤
- 将仓库克隆到本地并进入项目根目录。
- 安装依赖(如有 package.json,请执行相应的安装命令,例如 npm install)。
- 启动 MCP 服务器的常见方式(通过 MCP 客户端连接时启动该服务器进程),例如执行以下方式之一:
- 使用命令行通过 MCP 客户端启动:npx -y microcms-document-mcp-server
- 从支持 MCP 的客户端集成时,确保服务器名称与命令参数与如下配置保持一致
- 确保 docs 目录及其中的 Markdown 文件存在(如 general.md、各种类别的文档文件等),以便服务器返回有效内容。
服务器配置
MCP 客户端在连接该 MCP 服务器时所需的配置信息(JSON 格式,包含 server name、command、args 等),用于启动服务器进程并建立通信通道。说明:MCP 客户端本身不需要实现服务器端逻辑,只需要知道如何启动并与服务器通信。
- server_name: microcms-document-mcp-server
- command: npx
- args: -y, microcms-document-mcp-server 说明:客户端根据上述字段启动服务器进程并通过标准输入输出与之通信,随后可通过工具接口进行请求。
基本使用方法
- 通过 MCP 客户端调用 fetch_general、list_documents、search_document 等工具来获取文档信息与内容。
- 使用 fetch_general 获得总体信息后,再使用 list_documents 指定 category 来缩小范围,或使用 search_document 指定 filename(以及可选的 category)来读取具体文档内容。
- 将返回的文本内容与对话场景结合,提供给最终用户。
注意事项
- 该实现依赖 docs 目录中的 Markdown 文件,请确保 general.md 及各类别文档存在。
- 当前支持的文档类别包括 manual、content-api、management-api、image-api、mcp-server。
- 服务器通过 JSON-RPC 形式响应请求,错误信息遵循 MCP 的错误码规范,便于客户端处理。