Brasil API MCP server for AI agents

Brasil API MCP is a bridge that connects AI assistants to Brazilian public data services through the standardized Model Context Protocol. It allows you to query various Brazilian data like postal codes, company registration information, bank details, area codes, and more. This server makes it easy to interact with the Brasil API service using a consistent protocol.

Installation

To install the Brasil API MCP server, follow these steps:

# Clone the repository
git clone https://github.com/guilhermelirio/brasil-api-mcp
cd brasil-api-mcp

# Install dependencies
npm install

# Build the project
npm run build

Running the Server

To run the MCP server:

npm start

This will start the server that communicates via standard input/output (stdio).

Available Tools

The Brasil API MCP server provides access to various Brazilian data services through the following tools:

CEP (Postal Codes)

cep-search - Query address information from a Brazilian postal code (CEP)

CNPJ (Company Registration)

cnpj-search - Query information about a Brazilian company by its CNPJ (National Registry of Legal Entities)

Banks

bank-search - Find information about a Brazilian bank by its code
bank-list - List all Brazilian banks

DDD (Area Codes)

ddd-search - Find information about a Brazilian area code (DDD)

IBGE (Geography and Statistics)

ibge-states-list - List all Brazilian states with their information
ibge-state-search - Find information about a Brazilian state by its code or abbreviation
ibge-municipalities-list - List all municipalities of a Brazilian state by its abbreviation

Cambio (Currency Exchange)

cambio-currencies-list - List all available currencies for exchange rates
cambio-rate - Get exchange rates for a specific currency on a specific date

Registro BR (Domain Registration)

registrobr-domain-check - Check the status and availability of a .br domain name

Usage Examples

Querying a Brazilian Address by Postal Code

// Sample request to the CEP tool
const response = await callMcpTool("cep-search", {
  cep: "01001000"
});

// Response provides address details:
// {
//   cep: "01001000",
//   state: "SP",
//   city: "São Paulo",
//   neighborhood: "Sé",
//   street: "Praça da Sé",
//   service: "viacep"
// }

Getting Currency Exchange Rates

// Sample request to get USD exchange rate
const response = await callMcpTool("cambio-rate", {
  currency: "USD",
  date: "2023-08-10"
});

// Response provides detailed exchange information

These examples demonstrate how to integrate the Brasil API MCP server into your applications to access Brazilian public data services through a standardized interface.

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "brasil-api-mcp" '{"command":"npm","args":["start"],"cwd":"${workspaceRoot}"}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "brasil-api-mcp": {
            "command": "npm",
            "args": [
                "start"
            ],
            "cwd": "${workspaceRoot}"
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "brasil-api-mcp": {
            "command": "npm",
            "args": [
                "start"
            ],
            "cwd": "${workspaceRoot}"
        }
    }
}

3. Restart Claude Desktop for the changes to take effect