Brasil Api MCP Server

🚀 BrasilAPI MCP サーバー

統一されたインターフェースを通じて、さまざまなブラジルのリソースのデータをシームレスに照会できます。郵便番号、市外局番、銀行、祝日、税金などの情報を取得できます。充実した最新の BrasilAPI データを使用して、AI エージェントやアプリケーションを強化しましょう。

完全な公式ドキュメントはこちらで確認できます。

✨ 主な機能

このサーバーは、BrasilAPI の各エンドポイントにアクセスするためのツールを提供しています。基盤として、以下の JS クライアントを使用して API と通信しています。GitHub リンク

Smithery プラットフォーム上のツールページを確認することで、各ツールをチェックしてテストすることができます。

📦 インストール

依存関係のインストール

npm install

サーバーのビルド

npm run build

自動再構築による開発

npm run watch

デバッグ

MCP サーバーは stdio を通じて通信するため、デバッグは難しい場合があります。私たちは MCP Inspector の使用を推奨します。これはパッケージスクリプトとして利用できます。

npm run inspector

更新されたビルドを生成して確認するには、以下のコマンドを使用します。

npm run build-and-inspect

Inspector は、ブラウザでデバッグツールにアクセスするための URL を提供します。

💻 使用例

Smithery を通じた実行

Smithery を使用してこのサーバーを自動で実行するには、以下のコマンドを使用します。

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

Claude との使用

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

その他の統合（Cursor など）

Smithery プラットフォーム上のサーバーページを確認することで、Cursor などの他の統合オプションを取得できます。

ローカルコピーを使用したサーバーの実行

このプロジェクトをダウンロードした後、以下のコマンドを使用してサーバーを実行できます。

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

プロジェクトのルートディレクトリには Dockerfile ファイルもあり、これを使用してイメージをビルドして実行することができます。

サーバー機能のチェック

Smithery を使用して、この MCP サーバーの機能をチェックすることができます。

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

これにより、すべての利用可能なツール、それらのパラメータ、およびそれらの使用方法が表示されます。

📚 ドキュメント

プロジェクト構造

src/
  ├── apiClient/   # BrasilAPI クライアント
  ├── tools/       # ツールの実装
  ├── types/       # インターフェースと型
  ├── utils/       # ユーティリティ関数
  └── index.ts     # MCP メインファイル（サーバー設定とツールリスト）