使用说明

项目简介

Brasil API MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器,它通过 Brasil API 提供对巴西公共数据的访问工具。该服务器旨在作为 LLM 应用的后端,提供标准化的接口来访问和利用巴西的各类公共信息资源。

主要功能点

  • 数据访问工具: 提供多种工具,允许 LLM 客户端查询巴西的公共数据,包括:

    • 邮政编码 (CEP) 查询
    • 公司注册信息 (CNPJ) 查询
    • 银行信息查询
    • 地区区号 (DDD) 查询
    • 巴西地理统计局 (IBGE) 数据查询(州、城市等)
    • 货币汇率查询
    • 巴西域名 (.br 域名) 注册状态查询
  • MCP 标准协议: 遵循 Model Context Protocol,易于与支持 MCP 协议的 LLM 客户端集成。

  • 工具化接口: 将各种数据查询功能封装为独立的工具 (Tools),方便 LLM 客户端按需调用。

  • Stdio 传输: 使用标准输入/输出 (stdio) 作为默认的通信协议,简化部署和集成。

安装步骤

  1. 克隆仓库

    git clone https://github.com/guilhermelirio/brasil-api-mcp
    cd brasil-api-mcp
  2. 安装依赖 确保已安装 Node.js 和 npm,然后运行:

    npm install
  3. 构建项目

    npm run build

服务器配置

MCP 客户端需要配置以下信息以连接到 Brasil API MCP Server。以下是 JSON 格式的配置示例:

{
  "serverName": "Brasil-API-MCP",
  "command": "npm",
  "args": ["start"]
}

配置参数说明:

  • 'serverName': MCP 服务器的名称,可以自定义,例如 "Brasil-API-MCP"。
  • 'command': 启动 MCP 服务器的命令。由于项目使用 npm 管理,并且 'npm start' 命令用于启动服务器,因此这里设置为 '"npm"'。
  • 'args': 传递给启动命令的参数。'npm start' 命令实际上是运行 'start' 脚本,因此这里设置为 '["start"]'。

注意: 确保你的 MCP 客户端能够执行 'npm' 命令,并且在 'brasil-api-mcp' 仓库目录下运行 'npm start' 可以成功启动服务器。

基本使用方法

  1. 启动服务器 在 'brasil-api-mcp' 仓库目录下,运行以下命令启动 MCP 服务器:

    npm start

    服务器将通过 stdio 运行,并在控制台输出 "Brasil API Service running via stdio"。

  2. 客户端调用工具 使用支持 MCP 协议的 LLM 客户端,配置上述服务器信息后,即可调用服务器提供的工具。例如,使用 'cep-search' 工具查询邮政编码,或使用 'cnpj-search' 工具查询公司信息。

    客户端需要构造符合 MCP 协议的 JSON-RPC 请求,发送到服务器的标准输入,并从标准输出读取服务器的 JSON-RPC 响应。具体的请求和响应格式请参考 Model Context Protocol 的官方文档。

    示例工具调用 (CEP 查询):

    假设使用 'cep-search' 工具查询邮政编码 "01001000"。客户端需要发送如下 JSON-RPC 请求到服务器:

    {
      "jsonrpc": "2.0",
      "method": "callTool",
      "params": {
        "tool_name": "cep-search",
        "tool_arguments": {
          "cep": "01001000"
        }
      },
      "id": "1"
    }

    服务器将处理请求,调用 Brasil API 查询邮政编码信息,并将结果以 JSON-RPC 响应返回给客户端。

信息

分类

网页与API