Brasil API

🚀 Brasil API MCP

このプロジェクトは、Brasil API を通じてさまざまなブラジルの公共データサービスを照会するためのツールを提供する Model Context Protocol (MCP) サーバーです。

🚀 クイックスタート

Brasil API MCP は、標準化された Model Context Protocol を通じて、AI アシスタントとブラジルの公共データサービスを接続する橋渡しの役割を果たします。以下の情報へのアクセスを提供します：

• 郵便番号（CEP）
• 企業登録番号（CNPJ）
• 銀行情報
• 地域コード（DDD）
• IBGE（ブラジル地理統計局）データ
• 為替レート
• ドメイン登録状態（.br ドメイン）

📦 インストール

# リポジトリをクローンする
git clone https://github.com/guilhermelirio/brasil-api-mcp
cd brasil-api-mcp

# 依存関係をインストールする
npm install

# プロジェクトをビルドする
npm run build

💻 使用例

基本的な使用法

サーバーを起動する：

npm start

これにより、標準入出力（stdio）を通じて通信する MCP サーバーが起動します。

利用可能なツール

CEP (郵便番号)

• cep-search - ブラジルの郵便番号の住所情報を照会する

CNPJ (企業登録番号)

• cnpj-search - CNPJ に基づいてブラジルの企業情報を照会する

銀行

• bank-search - コードに基づいてブラジルの銀行情報を検索する
• bank-list - すべてのブラジルの銀行をリストする

DDD (地域コード)

• ddd-search - ブラジルの地域コード（DDD）の情報を照会する

IBGE (地理統計局)

• ibge-states-list - すべてのブラジルの州とその情報をリストする
• ibge-state-search - コードまたは略称に基づいてブラジルの州の情報を検索する
• ibge-municipalities-list - 州の略称に基づいてその管轄下のすべての自治体をリストする

為替 (Cambio)

• cambio-currencies-list - 為替レートを照会できるすべての通貨をリストする
• cambio-rate - 特定の日付の特定の通貨の為替レート情報を照会する

Registro BR (ドメイン登録)

• registrobr-domain-check - .br ドメインの状態と可用性を確認する

高度な使用法

郵便番号に基づくブラジルの住所を照会する

// サンプルリクエスト CEP ツール
const response = await callMcpTool("cep-search", {
  cep: "01001000"
});

// レスポンスには詳細な住所情報が含まれます：
// {
//   cep: "01001000",
//   state: "SP",
//   city: "São Paulo",
//   neighborhood: "Sé",
//   street: "Praça da Sé",
//   service: "viacep"
// }

為替レート情報を取得する

// サンプルリクエストで米ドルのレートを取得する
const response = await callMcpTool("cambio-rate", {
  currency: "USD",
  date: "2023-08-10"
});

// レスポンスには詳細な為替レート情報が含まれます

📄 ライセンス

このプロジェクトは、Guilherme Lirio Tomasi de Oliveira によって MIT ライセンスの下で提供されています。

謝辞

このプロジェクトでは、Brasil API サービスを使用しています。このサービスは、ブラジルの公共データに関連するさまざまな API を集約しています。Brasil API チームがコミュニティにこの貴重なサービスを提供してくれたことに感謝します。