项目简介

BrasilAPI MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,它集成了 BrasilAPI 提供的丰富巴西公共数据资源。该服务器旨在为大型语言模型(LLM)应用提供结构化的巴西数据访问能力,通过标准化的 MCP 协议,使得 LLM 可以安全、便捷地调用工具查询巴西的各类公开信息。

主要功能点

  • 数据工具集成: 提供多种工具,可以查询巴西的邮政编码、地区代码、银行信息、节假日、公司 CNPJ 信息、图书 ISBN 信息等。所有数据均来自权威的 BrasilAPI。
  • 标准化 MCP 接口: 遵循 MCP 协议标准,易于与各种 MCP 客户端集成,为 LLM 应用提供统一的数据访问入口。
  • 易于部署和运行: 支持本地部署运行,也易于通过 Smithery 等平台进行管理和集成。
  • 实时数据: 数据来源于 BrasilAPI,保证信息的实时性和准确性。

安装步骤

  1. 环境准备: 确保你的机器上已安装 Node.jsnpm
  2. 下载代码: 使用 Git 克隆仓库到本地:
    git clone https://github.com/mauricio-cantu/brasil-api-mcp-server.git
  3. 进入目录: 进入项目文件夹:
    cd brasil-api-mcp-server
  4. 安装依赖: 安装项目所需的 npm 包:
    npm install
  5. 构建项目: 编译 TypeScript 代码:
    npm run build

服务器配置

MCP 客户端需要以下配置信息来连接到 BrasilAPI MCP Server。请将以下 JSON 配置填入你的 MCP 客户端中。请务必将 'command' 字段中的路径替换为你实际的仓库绝对路径。

{
  "serverName": "brasil-api-mcp-server",
  "command": "/absolute/path/to/brasil-api-mcp-server/build/index.js",
  "args": [],
  "transport": "stdio"
}

配置参数说明:

  • 'serverName': 服务器名称,可以自定义,用于在客户端中标识该服务器。
  • 'command': 重要: 服务器启动命令。请将 '/absolute/path/to/brasil-api-mcp-server/build/index.js' 替换为 你本地仓库 'build/index.js' 文件的绝对路径。 这是服务器的可执行文件路径。
  • 'args': 启动参数,本服务器无需额外参数,保持为空数组 '[]' 即可。
  • 'transport': 传输协议,本服务器使用标准输入输出流 (stdio) 进行通信,固定为 'stdio'。

基本使用方法

  1. 启动服务器: 在终端中,使用 Node.js 运行编译后的服务器文件 (无需手动执行,MCP 客户端会自动启动)。
  2. 客户端连接: 在你的 MCP 客户端 (如 Smithery, Claude, Cursor 等) 中,根据客户端指引添加新的 MCP 服务器,并填入上述 服务器配置 信息。
  3. 调用工具: 客户端成功连接服务器后,你就可以在客户端界面或通过指令,调用服务器提供的各种工具了。例如,你可以使用 'get_postal_code_v2' 工具查询巴西邮政编码,或使用 'get_cnpj' 工具查询巴西公司信息。 具体工具的使用方法,可以参考客户端的帮助文档或工具列表。

信息

分类

网页与API