内容
# brazilian-cep-mcp
## 描述
这是一个MCP（Model Context Protocol）服务器，提供用于查询巴西邮政编码（CEP）信息的工具。该服务器使用ViaCEP API从提供的CEP获取详细的地址数据。
## 功能
- 通过CEP查询完整地址
- 返回信息包括：logradouro（街道）、bairro（社区）、cidade（城市）、estado（州）、região（地区）、DDD（区域代码）和IBGE代码
- 实现MCP协议以便与AI代理集成
## 安装
```bash
# 克隆仓库
git clone https://github.com/guilhermelirio/brazilian-cep-mcp.git
cd brazilian-cep-mcp
# 安装依赖
npm install
```
## 如何使用
### 编译项目
要编译TypeScript代码：
```bash
npm run build
```
### 运行服务器
要在开发模式下启动服务器：
```bash
npm run dev
```
要在编译后启动服务器：
```bash
npm start
```
### 查询一个CEP
服务器提供了工具`consultar-cep`，接受一个参数：
- `cep`: 8位数字格式的邮政编码（必填）
使用示例：
```json
{
"cep": "01001000"
}
```
响应：
```
找到的地址：
CEP: 01001-000
Logradouro: Praça da Sé
Complemento: lado ímpar
Bairro: Sé
Cidade: São Paulo
Estado: SP (São Paulo)
Região: Sudeste
DDD: 11
IBGE: 3550308
```
## 使用的技术
- TypeScript
- Node.js
- Axios用于HTTP请求
- Zod用于模式验证
- Model Context Protocol的SDK
## Smithery配置
该项目已配置为与Smithery.ai平台一起使用，该平台简化了MCP服务器的分发和执行。
## 项目结构
```
brazilian-cep-mcp/
├── src/
│ └── index.ts # 主要源代码
├── dist/ # 编译后的代码
├── node_modules/ # 依赖
├── smithery.yaml # Smithery配置
├── package.json # 项目配置
├── tsconfig.json # TypeScript配置
└── README.md # 本文件
```
## 作者
Guilherme Lirio Tomasi de Oliveira
## 许可证
该项目根据MIT许可证进行许可 - 请查看[LICENSE](LICENSE)文件以获取更多详细信息。
## 贡献
欢迎贡献！请随时提出问题或提交拉取请求。
MCP 市场