使用说明

项目简介

OnChains Dev MCP 是一个文档服务器，它使用 Model Context Protocol (MCP) 向 LLM 客户端提供文档资源和工具。该服务器托管了一系列文档，并允许客户端通过 MCP 协议以标准化的方式访问这些文档。它提供了资源访问功能，允许客户端根据文档主题、分类或子分类检索文档内容；同时提供了多种工具，例如文档搜索、主题列表和文档比较，以增强 LLM 应用处理文档的能力。

主要功能点

资源访问 (Resources)：
- 动态文档 (docs-dynamic)：根据文档 ID（topic）动态检索和返回单个文档的内容。例如，可以使用 'docs://getting-started' 访问 "getting-started" 文档。
- 分类文档列表 (docs-category)：根据文档分类（category）返回该分类下的文档列表，包括文档标题、描述和预览。例如，可以使用 'docs-category://guides' 获取 "guides" 分类下的文档列表。
- 子分类文档列表 (docs-subcategory)：根据文档分类和子分类（category/subcategory）返回特定子分类下的文档列表。例如，可以使用 'docs-subcategory://guides/advanced' 获取 "guides" 分类下 "advanced" 子分类的文档列表。
工具 (Tools)：
- 文档搜索 (search-docs)：允许客户端根据关键词搜索文档内容，返回匹配的文档列表，包含标题、描述、预览、分类和子分类信息。
- 主题列表 (list-topics)：列出所有文档分类和子分类，并提供访问对应分类和子分类文档列表的资源 URI。
- 分类列表 (list-categories)：列出所有可用的文档分类，并提供访问各分类文档列表的资源 URI。
- 文档比较 (compare-docs)：比较两个文档（通过文档 ID 或关键词指定），返回它们的标题、描述、访问 URI 和共同标签，方便 LLM 理解文档之间的异同。

安装步骤

克隆仓库

git clone https://github.com/nonomnonom/onchainsDevMCP.git
cd onchainsDevMCP

安装依赖 确保你已经安装了 Bun。然后在项目根目录下运行：
```
bun install
```

服务器配置

MCP 客户端需要配置以下信息以连接到 OnChains Dev MCP 服务器。以下是一个 JSON 格式的配置示例，请根据你的实际情况进行配置：

{
  "serverName": "OnChains Dev MCP",  // MCP 服务器名称，可以自定义
  "command": "bun",                   // 启动服务器的命令，这里使用 Bun 运行时
  "args": ["run", "src/server.ts"],    // 启动命令的参数，指定运行 src 目录下的 server.ts 文件
  "transport": "sse",                 // 使用 SSE (Server-Sent Events) 传输协议
  "endpointUri": "http://localhost:1234/sse" // SSE 连接端点，默认为 http://localhost:1234/sse
}

配置参数说明:

'serverName': MCP 服务器的名称，用于在客户端标识和管理连接。
'command': 运行服务器端代码的命令。本仓库使用 Bun 运行时，所以设置为 "bun"。
'args': 传递给 'command' 的参数，用于指定要执行的服务器端脚本。这里指定运行 'src/server.ts' 文件。
'transport': MCP 客户端与服务器通信使用的传输协议，本服务器使用 SSE。
'endpointUri': SSE 协议的连接端点 URI，客户端通过此 URI 与服务器建立连接。默认情况下，服务器运行在 'http://localhost:1234' 端口，并提供 '/sse' 端点用于 SSE 连接。

基本使用方法

启动服务器 在项目根目录下运行以下命令启动 MCP 服务器：
```
bun run src/server.ts
```
服务器成功启动后，你会在终端看到类似 'MCP Documentation Server running on port 1234' 的信息。
配置 MCP 客户端 根据你的 MCP 客户端软件的使用说明，配置上述提供的服务器配置信息。确保客户端能够连接到 'http://localhost:1234/sse' 这个端点。
使用资源和工具 一旦客户端成功连接到服务器，你就可以使用 MCP 协议访问文档资源和调用工具。
- 访问资源示例：
  - 获取 "getting-started" 文档： 'docs://getting-started'
  - 获取 "guides" 分类下的文档列表： 'docs-category://guides'
  - 获取 "guides" 分类下 "advanced" 子分类的文档列表： 'docs-subcategory://guides/advanced'
- 调用工具示例：
  - 搜索关键词 "configuration"：调用工具 'search-docs'，参数为 '{"query": "configuration"}'
  - 列出所有文档分类：调用工具 'list-categories'，无需参数
  - 比较 "getting-started" 和 "advanced-features" 文档：调用工具 'compare-docs'，参数为 '{"topic1": "getting-started", "topic2": "advanced-features"}'
具体的资源 URI 和工具调用方法请参考上述 "主要功能点" 部分的描述。MCP 客户端会根据你配置的服务器信息和调用的资源 URI 或工具，与 OnChains Dev MCP 服务器进行通信，并获取相应的文档数据或工具执行结果。

关键词