使用说明

项目简介

miru MCP 服务器是 miru 项目的一个组件，旨在作为 Model Context Protocol (MCP) 服务器运行，为语言模型 (LLM) 客户端提供访问软件包文档和相关信息的标准化接口。通过注册工具，miru MCP 服务器允许 LLM 客户端调用外部功能来获取软件库的上下文信息，从而增强 LLM 在软件开发和知识检索等方面的能力。

主要功能点

提供软件包 URL 检索工具 (fetch_library_urls): 允许 LLM 客户端根据软件包名称查询其相关的仓库、主页、注册中心和文档等链接信息。
提供软件包文档检索工具 (fetch_library_docs): 允许 LLM 客户端根据软件包名称获取其文档内容（如 README 文件）以及其他相关链接。

安装步骤

Go 安装 (推荐): 确保已安装 Go 语言环境 (Go 1.21 或更高版本)。打开终端并执行以下命令：
```
go install github.com/ka2n/miru/cmd/miru@latest
```
安装完成后，'miru' 命令应已添加到您的 '$PATH' 环境变量中。
包管理器安装 (macOS, Arch Linux, Alpine Linux, Debian/Ubuntu, RHEL/Rocky Linux): 您可以根据您的操作系统选择合适的包管理器进行安装，具体步骤请参考 miru GitHub 仓库的 README.md 中的 "Package Installation" 部分。

服务器配置

为了让 MCP 客户端连接到 miru MCP 服务器，您需要配置客户端的连接信息。以下是一个典型的 JSON 格式配置示例，您需要将此配置添加到您的 MCP 客户端配置中：

{
  "serverName": "miru-mcp",
  "command": "miru",
  "args": [
    "mcp"
  ],
  "transport": "stdio"
}

配置参数说明:

'serverName': 服务器名称，可以自定义，例如 "miru-mcp"。
'command': 启动 miru MCP 服务器的命令，这里设置为 'miru'，假设 'miru' 命令在您的环境变量 '$PATH' 中。
'args': 传递给 'miru' 命令的参数，这里设置为 '["mcp"]'，用于启动 MCP 服务器模式。
'transport': MCP 客户端与服务器通信的传输协议，这里设置为 'stdio'，表示使用标准输入输出流进行通信。

注意: 请确保 'miru' 命令在 MCP 客户端能够访问到的环境变量 '$PATH' 中。如果 'miru' 命令的路径不在默认 '$PATH' 中，您需要将 'command' 配置项设置为 'miru' 命令的完整路径。

基本使用方法

启动 miru MCP 服务器: 在终端中运行以下命令启动 miru MCP 服务器：
```
miru mcp
```
服务器启动后，将监听标准输入，等待 MCP 客户端的请求。
MCP 客户端调用工具: 配置并启动您的 MCP 客户端，客户端将通过 Stdio 协议连接到 miru MCP 服务器。您可以使用客户端调用以下工具来获取软件包信息：
- fetch_library_urls: 用于检索软件包相关 URL。客户端需要提供 'package' 参数（软件包名称，必填）和可选的 'lang' 参数（语言提示）。
- fetch_library_docs: 用于检索软件包文档内容。客户端需要提供 'package' 参数（软件包名称，必填）和可选的 'lang' 参数（语言提示）。
示例 (MCP 客户端请求 - fetch_library_urls):

假设您想使用 MCP 客户端调用 'fetch_library_urls' 工具来获取 'github.com/spf13/cobra' 软件包的 URL 信息，您需要构造符合 MCP 协议的 JSON-RPC 请求，并通过 Stdio 发送给 miru MCP 服务器。服务器将处理请求并返回包含 URL 信息的 JSON-RPC 响应。具体请求格式和客户端操作请参考 MCP 客户端的文档。

总结: miru MCP 服务器通过提供 'fetch_library_urls' 和 'fetch_library_docs' 两个工具，使得 LLM 客户端能够方便地获取软件包的文档和链接信息，从而在软件开发和知识检索等场景中为 LLM 提供有价值的上下文支持。

关键词