使用说明
项目简介
RFC文档MCP服务器是一个基于Model Context Protocol (MCP) 的后端服务,旨在为大型语言模型(LLM)应用提供访问和操作Request for Comments (RFC) 文档的能力。该服务器允许LLM客户端通过标准化的MCP协议,获取RFC文档内容、搜索RFC文档以及提取RFC文档的特定章节。
主要功能点
- 获取RFC文档: 通过RFC编号获取完整的RFC文档内容。
- 搜索RFC文档: 根据关键词搜索相关的RFC文档,返回匹配的RFC列表。
- 获取RFC章节: 获取指定RFC文档的特定章节内容。
- 支持多种格式: 能够解析HTML和TXT格式的RFC文档。
- 性能优化: 具备缓存机制,提高数据访问效率。
安装步骤
由于此仓库发布了npm包 '@mjpitz/mcp-rfc',因此无需手动安装仓库代码,MCP客户端可以直接配置使用该npm包。
服务器配置
MCP客户端需要配置以下JSON格式信息来连接和使用 RFC文档MCP服务器。请将以下配置添加到您的MCP客户端的服务器配置文件中,例如 'mcp-settings.json'。
{ "mcpServers": { "rfc-server": { "command": "npx", "args": ["@mjpitz/mcp-rfc"], "disabled": false, "autoApprove": [] } } }
配置参数说明:
- server name: 'rfc-server' (服务器名称,客户端用于标识和引用此服务器,可以自定义)
- command: 'npx' (启动服务器的命令,'npx' 用于执行 npm 包)
- args: '["@mjpitz/mcp-rfc"]' (传递给 'npx' 的参数,指定要执行的 npm 包名称 '@mjpitz/mcp-rfc',这将启动 RFC MCP 服务器)
- disabled: 'false' (设置为 'false' 表示启用此服务器)
- autoApprove: '[]' (自动批准的工具列表,默认为空,表示需要手动批准工具调用)
基本使用方法
配置完成后,您的MCP客户端应该能够发现并使用 RFC文档MCP服务器提供的功能。以下是一些基本的使用方法示例:
1. 使用资源 (Resources):
- 获取RFC文档: 使用资源 URI 'rfc://{number}',将 '{number}' 替换为具体的RFC编号,例如 'rfc://2616',即可获取RFC 2616文档的内容。
- 搜索RFC文档: 使用资源 URI 'rfc://search/{query}',将 '{query}' 替换为搜索关键词,例如 'rfc://search/http protocol',即可搜索包含 "http protocol" 关键词的RFC文档。
2. 调用工具 (Tools):
-
get_rfc: 获取指定编号的RFC文档。
- 参数:
- 'number' (string, 必填): RFC编号,例如 "2616"。
- 'format' (string, 可选): 输出格式,可选值包括 "full" (完整文档), "metadata" (元数据), "sections" (章节),默认为 "full"。
- 示例参数:
{ "number": "2616", "format": "metadata" }
- 参数:
-
search_rfcs: 搜索RFC文档。
- 参数:
- 'query' (string, 必填): 搜索关键词或短语。
- 'limit' (number, 可选): 最大返回结果数量,默认为 10。
- 示例参数:
{ "query": "http protocol", "limit": 5 }
- 参数:
-
get_rfc_section: 获取RFC文档的指定章节。
- 参数:
- 'number' (string, 必填): RFC编号,例如 "2616"。
- 'section' (string, 必填): 要获取的章节标题或编号。
- 示例参数:
{ "number": "2616", "section": "Introduction" }
- 参数:
请参考您的MCP客户端的具体文档,了解如何在客户端界面或代码中配置和使用MCP服务器的资源和工具。
信息
分类
网页与API