Skip to main content
Glama
README.md
# MCP-CEP

Servidor MCP para consulta de CEPs usando a API pública do [ViaCEP](https://viacep.com.br).  
Compatível com [Goose](https://block.github.io/goose/) como extensão de linha de comando (Command-line Extension).

---

### 👤 Autor

**Wendell Barreto**  
[https://github.com/wendellbigato](https://github.com/wendellbigato)  


---

## 🚀 Instalação

### 1. Clone este repositório

```bash
git clone https://github.com/wendellbigato/mcp-cep.git
cd mcp-cep
````

> Altere a URL acima para a real quando publicar.

---

### 2. Crie e ative o ambiente virtual

```bash
python3.11 -m venv .venv
source .venv/bin/activate  # Linux/macOS
# ou
.venv\Scripts\activate.bat  # Windows
```

---

### 3. Instale as dependências com `uv` ou `pip`

Usando [uv](https://github.com/astral-sh/uv):

```bash
uv pip install -e ".[cli]"
```

Ou com pip normal:

```bash
pip install -e ".[cli]"
```

---

## 🧩 Configurando como extensão no Goose

1. Execute:

```bash
goose configure
```

2. Selecione `Add Extension`

3. Escolha `Command-line Extension`

4. Preencha os campos:

| Campo              | Valor                                                                     |
| ------------------ | ------------------------------------------------------------------------- |
| **Extension name** | `mcp-cep`                                                                 |
| **Command to run** | `/caminho/completo/para/uv --directory /caminho/para/mcp-cep run main.py` |
| **Timeout**        | `300`                                                                     |
| **Environment**    | *(em branco, ou personalize se necessário)*                               |

Use `which uv` e `pwd` para encontrar os caminhos corretos.

---

## ✅ Como testar no Goose

Após configurar, inicie:

```bash
goose 
```

E envie comandos como:

```
Repita: Olá!
Qual o endereço do CEP 01001000?
```

---

## 🧰 Ferramentas disponíveis

* `echo(texto: str)`: repete o texto enviado.
* `buscar_cep(cep: str)`: consulta informações de endereço via ViaCEP.

---

## 📄 Licença

Este projeto está licenciado sob a licença MIT.

TDQS

B3.3/5.0

Scored across 3 tools

Disambiguation4/5

The first two tools have clearly distinct purposes: buscar_cep queries by CEP number, while buscar_ceps_por_logradouro queries by address components. However, the echo tool is completely unrelated to the CEP domain, creating a minor ambiguity about the server's primary focus. The core CEP tools are well-differentiated.

Naming Consistency3/5

Two tools follow a consistent Portuguese verb_noun pattern (buscar_cep, buscar_ceps_por_logradouro), but the third tool (echo) breaks this pattern with an English name. The naming is readable but lacks full consistency across the set due to the language and pattern mismatch.

Tool Count3/5

Three tools is borderline for a CEP server. While the two core CEP tools provide basic lookup functionality, the inclusion of an unrelated echo tool makes the count feel artificially inflated. For a focused CEP service, 2-4 domain-specific tools would be more appropriate.

Completeness3/5

The server covers the essential CEP lookup operations: query by CEP and query by address components. However, there are notable gaps for a complete CEP service - no tools for address validation, reverse geocoding, or handling CEP ranges. The echo tool adds no value to the CEP domain coverage.

Maintenance

ActivityInactive
ResponsivenessNo issues