Calebl Ynab MCP Server

🚀 ynab-mcp-server

このプロジェクトは、mcp-framework をベースに構築された YNAB（You Need A Budget）予算ツールのモデルコンテキストプロトコル (MCP) サーバーです。この MCP を通じて、https://ynab.com で設定した YNAB 予算とのやり取りが可能になります。

AI がこのツールとやり取りできるようにするには、個人用アクセストークンを取得する必要があります。取得方法はこちらを参照してください：https://api.ynab.com/#personal-access-tokens。この MCP サーバーをクライアントに追加する際には、YNAB_API_TOKEN として個人用アクセストークンを提供する必要があります。このトークンは、決して LLM（大規模言語モデル）に直接送信されることはありません。 環境変数に安全に保存され、YNAB API との通信にのみ使用されます。

🚀 クイックスタート

環境変数の指定

• YNAP_API_TOKEN（必須）
• KNOWLEDGE_DIR（任意）- 知識ファイルの保存ディレクトリ。デフォルトはサーバーが実行される data ディレクトリです。
• KNOWLEDGE_FILE（任意）- 知識ファイルの名前。デフォルトは server-knowledge.json です。

セットアップ手順

1. リポジトリをクローンします：git clone https://github.com/your-repository.git
2. 依存関係をインストールします：npm install
3. 環境変数を設定します：

   export YNAP_API_TOKEN=your_token_here
   

4. サーバーを起動します：node dist/index.js

✨ 主な機能

このプロジェクトの目的は、AI 対話を通じて YNAB 予算とのやり取りを可能にすることです。以下の主要なワークフローが実装されています。

初回設定

• 利用可能な予算から予算を選択するように促されます。他のツールを使用する前にこのツールを使用すると、デフォルトの予算を設定するように求められます。
  • 必要なツール：ListBudgets、SetBudget

超過支出カテゴリの管理

新しい取引の追加

取引の承認

月間総支出と総収入の比較チェック

カテゴリ目標に基づく自動資金配分

📦 インストール

1. リポジトリをクローン：git clone https://github.com/your-repository.git
2. 依存関係のインストール：npm install
3. 環境変数の設定：

   export YNAP_API_TOKEN=your_token_here
   

4. サーバーの起動：node dist/index.js

💻 使用例

基本的な使用法

# リポジトリのクローン
git clone https://github.com/your-repository.git
# 依存関係のインストール
npm install
# 環境変数の設定
export YNAP_API_TOKEN=your_token_here
# サーバーの起動
node dist/index.js

📚 ドキュメント

プロジェクト構造

.
├── src/
│   ├── tools/           # ツールディレクトリ、YNAB API とのやり取りを行うツールクラスが含まれます
│   │   └── ynabTools.ts
│   └── server.ts       # メインサーバーファイル
├── package.json        # プロジェクトの依存関係とスクリプト
└── README.md           # プロジェクトドキュメント

新しいコンポーネントの追加方法

1. src/tools/ ディレクトリに新しいツールクラスを作成します。
2. YNAB API とのやり取りのロジックを実装します。
3. サーバーファイルを更新して新しいツールを読み込みます。

ツール開発

• 基本構造：

  export class YNABTools {
      private readonly token: string;
  
      constructor(token: string) {
          this.token = token;
      }
  
      // 具体的な機能メソッドを実装
  }
  

npm への公開

1. npm にログイン：npm login
2. バージョン更新をコミット：npm version patch
3. 新しいバージョンを公開：npm publish

🔧 技術詳細

現在の状態

• ツールリスト：
  • ListBudgets：すべての予算をリスト表示
  • SetBudget：デフォルトの予算を設定
  • GetCategories：予算カテゴリを取得
  • CreateCategory：新しい予算カテゴリを作成
  • UpdateCategory：既存の予算カテゴリを更新
  • DeleteCategory：予算カテゴリを削除
• 今後の予定：
  • 取引管理機能の追加（CreateTransaction、UpdateTransaction、DeleteTransaction）
  • 予算トラッキングとレポートの実装

📄 ライセンス

原文書にライセンス情報は記載されていません。

その他の情報

• 他の MCP クライアントについては、https://modelcontextprotocol.io/clients を参照してください。
• 詳細な情報は、MCP フレームワーク Github と MCP フレームワークドキュメント を参照してください。