Ynab MCP Server

🚀 ynab - mcp - server

このプロジェクトは、mcp - framework を使用して構築された Model Context Protocol (MCP) サーバーです。この MCP を通じて、https://ynab.com の YNAB 予算とのやり取りが可能になります。

AI がこのツールとやり取りできるようにするには、個人用アクセストークンを取得する必要があります。これは、https://api.ynab.com/#personal - access - tokens から取得できます。この MCP サーバーをクライアントに追加する際には、YNAB_API_TOKEN として個人用アクセストークンを提供する必要があります。このトークンは決して直接 LLM に送信されません。 環境変数として秘密裏に保存され、YNAB API の呼び出しにのみ使用されます。

🚀 クイックスタート

このサーバーを使用するには、まず環境変数を設定する必要があり、その後インストールと起動を行います。

✨ 主な機能

• 予算データのインポート：YNAB から予算データをインポートし、MCP 互換形式に解析します。
• データクエリ：カテゴリや時間範囲などによる複雑な予算データのクエリをサポートします。
• 操作フィードバック：ユーザーの指示に基づいて、操作結果のリアルタイムなフィードバックを提供します。

📦 インストール

1. リポジトリをクローンします。

git clone https://github.com/your-repository.git
cd ynab-mcp-server

2. 依存関係をインストールします。

npm install

3. サーバーを起動します。

node dist/index.js

💻 使用例

基本的な使用法

// 予算データのインポート
export async function fetchBudgetData(token: string, budgetId?: string) {
    // 実装は YNAB から予算データを取得するロジック
}

// データクエリ
export interface QueryOptions {
    category?: string;
    startDate?: string;
    endDate?: string;
}

export async function queryData(options: QueryOptions) {
    // 複雑なクエリロジックを実装
}

📚 ドキュメント

環境構成

以下の環境変数を指定します。

• YNAB_API_TOKEN（必須）
• YNAB_BUDGET_ID（オプション）

プロジェクトの目的

このプロジェクトの目的は、AI ダイアログを通じて個人の YNAB 予算とのやり取りを実現することです。

ワークフロー

初回設定

• 所有する予算を選択するように促します。他のツールで事前に設定されていない場合は、自動的にガイド付きで設定を完了します。
• 環境変数に YNAB_API_TOKEN と YNAB_BUDGET_ID を提供します。

プロジェクト構造

核心ファイル

• index.js：MCP サーバーの初期化を担当するエントリーファイルです。
• config.js：環境変数とデフォルト値を設定します。
• tools/：具体的なツールモジュールが含まれています。

ツールの実装

予算データのインポート (ynab.ts)

export async function fetchBudgetData(token: string, budgetId?: string) {
    // 実装は YNAB から予算データを取得するロジック
}

データクエリ (query.ts)

export interface QueryOptions {
    category?: string;
    startDate?: string;
    endDate?: string;
}

export async function queryData(options: QueryOptions) {
    // 複雑なクエリロジックを実装
}

デプロイとテスト

ローカル開発

1. ツールのコードを変更します。
2. npm run build を実行してコンパイルします。
3. サーバーを起動すると、更新されたツールが自動的に読み込まれます。

テスト

• すべての API 呼び出しが成功し、正しいデータが返されることを確認します。
• クエリ機能が期待どおりに動作することを検証します。

学習リソース

• MCP フレームワーク GitHub
• MCP フレームワークドキュメント