Xero MCP Server

🚀 Xero モデルコンテキストプロトコル（MCP）サーバー

Xero MCP サーバーは、Xero 会計システムとの相互作用に使用するツールです。モデルコンテキストプロトコル（MCP）仕様によるインターフェースを提供し、さまざまな財務および給与データの作成、読み取り、更新、削除をサポートします。

🚀 クイックスタート

Xero MCP サーバーを使用するには、まずインストールと構築を行い、環境変数を設定する必要があります。

📦 インストール

# npmを使用する場合
npm install

# pnpmを使用する場合
pnpm install

🔨 ビルドの実行

# npmを使用する場合
npm run build

# pnpmを使用する場合
pnpm build

⚙️ 環境変数の設定

.env ファイルなどの機密情報をバージョン管理システムにコミットしないようにしてください。

✨ 主な機能

サポートされる操作

クエリ操作

• list_xero_contacts: すべての連絡先を取得します。
• list_xero_invoices: すべての請求書を取得します。
• list_xero_payments: すべての支払い記録を取得します。
• list_xero_quotes: すべての見積書を取得します。
• list_payroll_employees: すべての給与従業員情報を取得します。
• list_payroll_leave_types: すべての利用可能な休暇タイプを取得します。

操作例

連絡先のクエリ

curl --location 'http://localhost:3000/api/contacts' \
--header 'Content-Type: application/json'

新しい連絡先の作成

curl --location 'http://localhost:3000/api/contacts' \
--method POST \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "John Doe",
    "email": "john.doe@example.com"
}'

⚠️ セキュリティに関する注意事項

開発環境と本番環境の両方で、API キーやその他の機密情報を安全に扱うようにしてください。これらの情報を環境変数に保存することをおすすめします。コードやバージョン管理システムに直接記述しないでください。

📁 プロジェクト構造

xero-mcp-server/
├── src/               # ソースコードディレクトリ
│   ├── index.js      # エントリーファイル
│   ├── routes/       # ルート定義
│   └── controllers/  # コントローラーロジック
├── package.json      # パッケージ管理ファイル
└── .env.example      # 環境変数のサンプル

🤝 コントリビューションガイド

コントリビューションを歓迎します！このリポジトリをフォークし、プルリクエストを送信してください。コードを送信する前に、テストを通過していることを確認してください。

📄 ライセンス

このプロジェクトは MIT ライセンスを使用しています。詳細については、LICENSE ファイルを参照してください。

注意： このツールを使用する際には、Xero のサービス利用規約とデータプライバシーポリシーを遵守してください。