Brasil API

🚀 Brasil API MCP

Brasil API MCP 是一个基于 Model Context Protocol (MCP) 的服务器，它借助 Brasil API 提供工具，可查询多种巴西公共数据服务，为用户获取巴西相关信息提供了便捷途径。

🚀 快速开始

Brasil API MCP 是连接 AI 助手与巴西公共数据服务的桥梁，通过标准化的 Model Context Protocol 实现。它提供了对多种巴西公共数据的访问，如邮政编码、公司注册号、银行信息等。

✨ 主要特性

• 提供对多种巴西公共数据的访问，包括邮政编码（CEP）、公司注册号（CNPJ）、银行信息、区域代码（DDD）、IBGE 数据、外汇汇率、域名注册状态（.br 域名）。
• 通过标准化的 Model Context Protocol 实现与 AI 助手的连接。

📦 安装指南

# 克隆仓库
git clone https://github.com/guilhermelirio/brasil-api-mcp
cd brasil-api-mcp

# 安装依赖
npm install

# 构建项目
npm run build

💻 使用示例

基础用法

运行服务器：

npm start

这将启动通过标准输入输出（stdio）通信的 MCP 服务器。

高级用法

根据邮政编码查询巴西地址

// 示例请求 CEP 工具
const response = await callMcpTool("cep-search", {
  cep: "01001000"
});

// 响应提供详细地址信息：
// {
//   cep: "01001000",
//   state: "SP",
//   city: "São Paulo",
//   neighborhood: "Sé",
//   street: "Praça da Sé",
//   service: "viacep"
// }

获取外汇汇率信息

// 示例请求获取美元汇率
const response = await callMcpTool("cambio-rate", {
  currency: "USD",
  date: "2023-08-10"
});

// 响应提供详细的汇率信息

📚 详细文档

可用工具

CEP (邮政编码)

• cep-search - 查询巴西邮政编码的地址信息

CNPJ (公司注册号)

• cnpj-search - 根据 CNPJ 查询巴西公司的信息

银行

• bank-search - 根据代码查找巴西银行的信息
• bank-list - 列出所有巴西银行

DDD (区域代码)

• ddd-search - 查询巴西区域代码（DDD）的信息

IBGE (地理统计局)

• ibge-states-list - 列出所有巴西州及其信息
• ibge-state-search - 根据代码或缩写查找巴西州的信息
• ibge-municipalities-list - 根据州的缩写列出其下辖的所有市镇

外汇 (Cambio)

• cambio-currencies-list - 列出所有可查询外汇汇率的货币
• cambio-rate - 查询特定日期某货币的汇率信息

Registro BR (域名注册)

• registrobr-domain-check - 检查 .br 域名的状态和可用性

📄 许可证

MIT © Guilherme Lirio Tomasi de Oliveira

致谢

该项目使用了 Brasil API 服务，该服务聚合了多种与巴西公共数据相关的 API。特别感谢 Brasil API 团队为社区提供的这项宝贵服务。