内容
# Brasil API MCP
一个模型上下文协议(Model Context Protocol,MCP)服务器,提供工具通过 [Brasil API](https://brasilapi.com.br/) 查询各种巴西数据服务。
## 概述
Brasil API MCP 是一个桥梁,通过标准化的模型上下文协议将 AI 助手与巴西公共数据服务连接起来。它提供对各种信息的访问,例如:
- 邮政编码(CEP)
- 公司注册(CNPJ)
- 银行信息
- 区号(DDD)
- IBGE(巴西地理统计局)数据
- 货币汇率
- 域名注册状态(.br 域名)
## 安装
```bash
# 克隆仓库
git clone https://github.com/guilhermelirio/brasil-api-mcp
cd brasil-api-mcp
# 安装依赖
npm install
# 构建项目
npm run build
```
## 使用
要运行服务器:
```bash
npm start
```
这将启动通过标准输入/输出(stdio)进行通信的 MCP 服务器。
## 可用工具
### CEP(邮政编码)
- `cep-search` - 根据巴西邮政编码(CEP)查询地址信息
### 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 域名的状态和可用性
## 集成示例
### 根据邮政编码查询巴西地址
```typescript
// 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"
// }
```
### 获取货币汇率
```typescript
// 获取美元汇率的示例请求
const response = await callMcpTool("cambio-rate", {
currency: "USD",
date: "2023-08-10"
});
// 响应提供详细的汇率信息
```
## 贡献
该项目使用了 [Brasil API](https://brasilapi.com.br/) 服务,该服务聚合了与巴西公共数据相关的各种 API。特别感谢 Brasil API 团队为社区提供这一宝贵服务。
## 许可证
MIT © [Guilherme Lirio Tomasi de Oliveira](https://github.com/guilhermelirio)