brasil-api-mcp-server

🚀 BrasilAPI MCP 服务器

通过统一的接口无缝查询各种巴西资源的数据。获取邮政编码、区号、银行、节日、税收等信息。使用丰富且更新及时的 BrasilAPI 数据增强您的 AI 代理和应用程序。

查看完整的官方文档 此处。

🚀 快速开始

此服务器可让你通过统一接口无缝查询各类巴西资源的数据。若想了解完整的官方文档，可点击 此处。

✨ 主要特性

• 提供统一接口，可无缝查询各种巴西资源的数据，如邮政编码、区号、银行、节日、税收等。
• 数据丰富且更新及时，能有效增强 AI 代理和应用程序。
• 提供访问 BrasilAPI 每个端点的工具。

📦 安装指南

安装依赖

npm install

构建服务器

npm run build

带有自动重建的开发

npm run watch

💻 使用示例

集成到 AI 应用程序

通过 Smithery 运行

使用 Smithery 自动运行此服务器：

npx -y @smithery/cli install @mauricio-cantu/brasil-api-mcp-server

与 Claude 使用

npx -y @smithery/cli@latest install @mauricio-cantu/brasil-api-mcp-server --client claude

其他集成（如 Cursor）

查看 Smithery 平台上的服务器页面，获取其他集成选项，例如 Cursor 等。

使用本地副本运行服务器

下载此项目后，可以使用以下命令运行服务器：

node /absolute/path/to/brasil-api-mcp-server/build/index.js

在项目的根目录下还有一个 Dockerfile 文件，可用于构建和运行镜像。

服务器功能检查

您可以使用 Smithery 检查此 MCP 服务器的功能：

npx -y @smithery/cli@latest inspect @mauricio-cantu/brasil-api-mcp-server

这将显示所有可用工具、它们的参数以及如何使用它们。

📚 详细文档

工具

此服务器提供了访问 BrasilAPI 每个端点的工具。底层使用以下 JS 客户端与 API 通信：GitHub 链接

查看 Smithery 平台上的工具页面，以检查和测试每个工具。

开发

调试

由于 MCP 服务器通过 stdio 通信，调试可能具有挑战性。我们推荐使用 MCP Inspector，它作为包脚本可用：

npm run inspector

要生成更新的构建并检查：

npm run build-and-inspect

Inspector 会提供一个 URL，用于在浏览器中访问调试工具。

🔧 技术细节

项目结构

src/
  ├── apiClient/   # BrasilAPI 客户端
  ├── tools/       # 工具实现
  ├── types/       # 接口和类型
  ├── utils/       # 工具函数
  └── index.ts     # MCP 主文件（服务器设置和工具列表）