BrasilAPI

A Model Context Protocol (MCP) server that provides tools to query BrasilAPI across different clients and LLMs. Enhance your AI apps with rich data from Brasil resources.

typescript

6

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "mauricio-cantu-brasil-api-mcp-server": {
      "command": "node",
      "args": [
        "/absolute/path/to/brasil-api-mcp-server/build/index.js"
      ]
    }
  }
}

BrasilAPI MCP Server exposes BrasilAPI data sources through a single MCP interface, enabling you to query endpoints like postal codes, area codes, banks, holidays, taxes, and more in AI-powered applications with a consistent, extensible toolset.

How to use

You connect to the BrasilAPI MCP Server from your MCP client to access a broad set of BrasilAPI endpoints. The server exposes tools that map to BrasilAPI endpoints, so you can search for data such as postal codes, banks, holidays, taxes, and more through unified commands. You can run the server locally or deploy it through Smithery for streamlined integration. Use the available tools to query data, inspect tool parameters, and combine results across endpoints to power agents and applications.

When you run the server through Smithery, you install the MCP server with a simple CLI command and then access the MCP URL that Smithery provides. If you prefer running a local copy, you can start the server directly with Node once you have built the project.

How to install

Prerequisites you need before installation: Node.js and npm (Node.js runtime environment). Ensure you have a recent LTS version installed on your system.

Install dependencies for the project.

Build the server for production or local use.

Enable development features with auto-rebuild for quicker iterations.

If you want debugging tools during development, install the MCP Inspector tooling.

npm install

npm run build

npm run watch

npm run inspector

To generate an updated build and inspect debugging tools, run:

npm run build-and-inspect

Running the server with a local copy is done by starting the built index file with Node. Use the following command and specify the absolute path to your built index file.

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

Additional notes on installation and deployment

You can also deploy and run the server through Smithery for managed hosting and convenient integration options. The CLI allows you to install and start the MCP server with a single command.

If you need a local containerized option, there is a Dockerfile available to build and run the image.

Integration and debugging tips

Inspect the server’s capabilities to understand which tools are exposed and how to use them. You can query the capabilities through the Smithery tooling to view available tools, parameters, and usage.

For debugging, you can use the MCP Inspector workflow to access debugging tools in your browser. This helps you diagnose parameter usage and data returned from BrasilAPI endpoints.