关键词

Rust文档crate信息代码搜索库访问开发者工具

项目简介

Bookworm 是一个 Model Context Protocol (MCP) 服务器，旨在为 LLM 客户端提供访问 Rust crate 文档的能力。它允许 LLM 搜索 crate，浏览 crate 条目（类型、函数等），访问 README 文件，并检索源代码，所有这些都在来自 docs.rs 的 Rust 库文档的上下文中进行。

主要功能点

  • 资源管理: 托管和管理 Rust crate 文档作为资源，提供对 crate 信息的结构化访问。
  • 工具注册与执行: 提供一系列工具，允许 LLM 客户端搜索 crate 和 crate 条目，检索 crate 资源（元数据、README、源代码）以及列出 crate 版本。
  • JSON-RPC 通信: 使用标准的 JSON-RPC 协议与 MCP 客户端进行通信，接收请求并返回响应。
  • 预定义工具: 内置了如 'crates_search' (crate 搜索), 'crate_search_items' (crate 条目搜索), 'crate_resource' (crate 资源获取), 'crate_versions' (crate 版本列表) 和 'crate_readme' (crate README 获取) 等工具，方便 LLM 客户端调用。

安装步骤

  1. 克隆仓库: 在你的终端中运行 'git clone https://github.com/dcdpr/bookworm' 克隆 Bookworm 仓库到本地。
  2. 进入目录: 使用 'cd bookworm' 命令进入克隆下来的 'bookworm' 目录。
  3. 编译 wrm-mcp 二进制文件: 运行 'cargo build --bin wrm-mcp' 命令编译 'wrm-mcp' 服务器程序。 编译成功后，'wrm-mcp' 可执行文件通常会位于 'target/debug/wrm-mcp' 目录下。

服务器配置

要将 Bookworm MCP 服务器添加到 MCP 客户端，需要在客户端中配置服务器连接信息。以下是一个配置示例，你需要将 '/path/to/bookworm/target/debug/wrm-mcp' 替换为你实际的 'wrm-mcp' 可执行文件路径。

{
  "mcpServers": {
    "bookworm": {
      "command": "/path/to/bookworm/target/debug/wrm-mcp"
    }
  }
}

配置参数说明:

  • 'server name': 'bookworm' (服务器名称，可以自定义)
  • 'command': '/path/to/bookworm/target/debug/wrm-mcp' ( 'wrm-mcp' 可执行文件的绝对路径)

基本使用方法

  1. 启动 Bookworm MCP 服务器: 在终端中执行编译生成的 'wrm-mcp' 二进制文件，例如：'/path/to/bookworm/target/debug/wrm-mcp'。服务器启动后会在终端保持运行状态。
  2. 配置 MCP 客户端: 打开你的 MCP 客户端，按照客户端的指导配置 MCP 服务器。通常需要将上面提供的 JSON 配置信息添加到客户端的服务器列表中。
  3. 使用 MCP 客户端与 Bookworm 交互: 配置完成后，你的 MCP 客户端就可以通过 Bookworm 服务器提供的工具来访问 Rust crate 文档了。例如，你可以指示 LLM 客户端使用 'crates_search' 工具搜索 'serde_json' crate，或者使用 'crate_readme' 工具获取 'serde_json' crate 的 README 内容。

信息

分类

开发者工具

访问项目