Brasil Api MCP Server

🚀 BrasilAPI MCP Server

Seamlessly query data from various Brazilian resources through a unified interface. Retrieve information such as postal codes, area codes, banks, holidays, taxes, etc. Enhance your AI agents and applications with the rich and up - to - date BrasilAPI data.

Check out the full official documentation here.

✨ Features

This server provides tools to access each endpoint of BrasilAPI. It uses the following JS client to communicate with the API under the hood: GitHub Link.

Check and test each tool on the Tools page on the Smithery platform.

📦 Installation

Install dependencies

npm install

Build the server

npm run build

Development with auto - rebuild

npm run watch

Debugging

Since the MCP server communicates via stdio, debugging can be challenging. We recommend using MCP Inspector, which is available as a package script:

npm run inspector

To generate an updated build and inspect:

npm run build-and-inspect

The Inspector will provide a URL to access the debugging tools in the browser.

💻 Usage Examples

Run through Smithery

Automatically run this server using Smithery:

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

Use with Claude

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

Other integrations (e.g., Cursor)

Check the Server page on the Smithery platform for other integration options, such as Cursor.

Run the server using a local copy

After downloading this project, you can run the server using the following command:

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

There is also a Dockerfile in the root directory of the project, which can be used to build and run the image.

📚 Documentation

You can check the capabilities of this MCP server using Smithery:

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

This will display all available tools, their parameters, and how to use them.

🔧 Technical Details

src/
  ├── apiClient/   # BrasilAPI client
  ├── tools/       # Tool implementations
  ├── types/       # Interfaces and types
  ├── utils/       # Utility functions
  └── index.ts     # MCP main file (server setup and tool list)