Brasil Api

smithery badge

Query a variety of data from Brasil resources seamlessly. Access information on postal codes, area codes, banks, holidays, taxes, and more through a unified interface. Enhance your AI agents and applications with rich and updated data from BrasilAPI effortlessly.

Check the complete and official documentation from BrasilAPI here.

Tools

This server provides tools to query every endpoint available from BrasilAPI. Under the hood, it uses this JS client to communicate with the API: https://github.com/WillianAgostini/brasilapi-js

Check the Tools page in Smithery to inspect and test each one of them.

Development

Install dependencies:

npm install

Build the server:

npm run build

For development with auto-rebuild:

npm run watch

Debugging

Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the 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 debugging tools in your browser.

Integration with AI applications

Running through Smithery

Run the server automatically via Smithery:

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

Usage with Claude

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

Cursor and other integrations

Check the Server page in Smithery to get other integration options such as Cursor and more.

Running the server with a local copy

After you've downloaded this project, you can run the server using node:

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

At the root of the project there's also a Dockerfile to build and run the image if you'd like.

Server's capabilities inspection

You can inspect this MCP server's capabilities using Smithery:

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

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

Project structure

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