使用说明

项目简介

JSR文档 MCP 服务器是一个实现了 Model Context Protocol (MCP) 的后端应用,它允许 LLM 客户端通过标准化的 MCP 协议访问 JSR (JavaScript Registry) 模块的文档。该服务器提供了一个名为 'jsr_docs' 的工具,用于检索指定 JSR 模块的文档内容。

主要功能点

  • MCP 协议支持: 遵循 MCP 协议规范,能够与 MCP 客户端进行通信。
  • JSR 文档检索: 提供 'jsr_docs' 工具,允许客户端请求 JSR 模块的文档。
  • 工具化能力: 通过工具的方式暴露 JSR 文档查询功能,方便 LLM 按需调用。
  • 文本格式输出: 'jsr_docs' 工具返回纯文本格式的模块文档,易于 LLM 理解和处理。

安装步骤

  1. 安装 Deno: 确保你的环境中已安装 Deno JavaScript/TypeScript 运行时环境。你可以访问 https://deno.land 获取安装指南。
  2. 下载仓库代码: 从 GitHub 仓库 https://github.com/sigmaSd/jsr-mcp 下载源代码到本地。

服务器配置

为了让 MCP 客户端连接到 JSR文档 MCP 服务器,你需要配置客户端的服务器连接信息。以下是一个 JSON 格式的配置示例,你需要将其添加到你的 MCP 客户端配置中。

{
  "serverName": "jsr-docs-mcp-server",
  "command": "deno",
  "args": ["run", "-A", "server.ts"]
}

配置参数说明:

  • 'serverName': 服务器的名称,可以自定义,用于在客户端中标识该服务器,例如 '"jsr-docs-mcp-server"'。
  • 'command': 启动服务器的命令,这里使用 'deno' 命令来运行 Deno 程序。
  • 'args': 启动命令的参数列表。
    • '"run"': Deno 的 'run' 子命令,用于运行脚本。
    • '"-A"': Deno 的权限标志,'-A' 表示授予脚本所有权限,因为服务器需要访问网络和执行子进程来获取文档。
    • '"server.ts"': 服务器主程序文件名为 'server.ts'。

注意: 请确保你的 MCP 客户端能够正确执行 'deno' 命令,并且 'server.ts' 文件路径相对于客户端配置是正确的。

基本使用方法

  1. 启动服务器: 在你的终端中,进入 'server.ts' 文件所在的目录,并使用配置中 'command' 和 'args' 里的命令启动服务器。通常情况下,直接在仓库根目录执行 'deno run -A server.ts' 即可。服务器启动后,会监听标准输入和输出,等待 MCP 客户端的请求。

  2. 客户端请求工具: 在 MCP 客户端中,你可以调用 'jsr_docs' 工具来获取 JSR 模块的文档。你需要提供 'module' 参数,指定要查询文档的 JSR 模块名称。例如,要获取 '@std/path' 模块的文档,你可以向服务器发送如下 JSON-RPC 请求 (简化示例,实际请求格式需参考 MCP 协议):

    {
      "method": "tool/invoke",
      "params": {
        "tool_name": "jsr_docs",
        "arguments": {
          "module": "@std/path"
        }
      }
    }
  3. 服务器返回文档: 服务器收到请求后,会调用 Deno 的 'doc' 命令获取 '@std/path' 模块的文档,并将文档内容以文本格式返回给 MCP 客户端。客户端可以解析响应,并向用户展示 JSR 模块的文档信息。

信息

分类

开发者工具