使用说明
项目简介
factbook-mcp 是一个基于 Model Context Protocol (MCP) 的服务器实现,它允许 LLM 客户端通过标准化的 MCP 协议访问 CIA World Factbook 的数据。该服务器提供了一个名为 'get-country-info' 的工具,用于查询特定国家的信息,并提供了一个 'regions.json' 资源,列出了可用的地区。
主要功能点
- 国家信息查询工具 (get-country-info): 允许 LLM 客户端通过国家代码和地区查询 CIA World Factbook 中关于该国家的详细信息。
- 地区列表资源 (regions.json): 提供 JSON 格式的地区列表,用于辅助工具的参数选择。
安装步骤
- 安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm (Node Package Manager)。
- 克隆仓库: 使用 Git 克隆 factbook-mcp 仓库到本地:
git clone https://github.com/Joshuatanderson/factbook-mcp.git - 进入仓库目录: 导航到克隆下来的仓库目录:
cd factbook-mcp - 安装依赖: 使用 npm 安装项目依赖:
npm install - 构建项目: 构建 TypeScript 代码到 JavaScript:
npm run build
服务器配置
MCP 客户端需要配置以下 JSON 信息以连接到 factbook-mcp 服务器。这个配置定义了如何启动服务器进程。
{ "serverName": "factbook", "command": "node", "args": ["build/index.js"] }
- 'serverName': 服务器的名称,这里是 "factbook"。
- 'command': 启动服务器的命令,这里使用 'node' 运行 JavaScript 文件。
- 'args': 传递给命令的参数,这里指定了构建后的服务器入口文件 'build/index.js'。
基本使用方法
- 启动 MCP 客户端: 确保你正在使用的 MCP 客户端已正确安装和配置。
- 配置服务器连接: 在 MCP 客户端中,按照其文档指引,配置上述提供的服务器连接信息。客户端将使用 Stdio 传输协议与 factbook-mcp 服务器通信。
- 使用工具和资源: 客户端连接成功后,可以:
- 使用 'ListResourcesRequest' 请求列出可用的资源,例如 'regions.json',并通过 'ReadResourceRequest' 读取资源内容,获取地区列表。
- 使用 'ListToolsRequest' 请求列出可用的工具,例如 'get-country-info'。
- 使用 'CallToolRequest' 调用 'get-country-info' 工具,并提供 'country' (国家代码) 和 'region' (地区) 作为参数,以查询国家信息。
注意: 'country' 参数需要使用 CIA World Factbook 使用的 GEC (原 FIPS) 代码,例如 'au' 代表奥地利,'gm' 代表德国。'region' 参数需要从 'regions.json' 资源中获取有效值,例如 'europe', 'africa' 等。
信息
分类
网页与API