Argocd MCP

🚀 Argo CD MCP サーバー

Argo CD API とのインタラクションに使用される MCP サーバーです。このサーバーは、Argo CD との通信を容易にし、開発者に便利な機能を提供します。

✨ 主な機能

• 統合開発環境 (IDE) フレンドリー：自動補完と型ヒントをサポートし、開発効率を向上させます。
• 静的型チェック：mypy を使用して厳格なコード品質管理を実現します。
• モジュール化アーキテクチャ：明確なコード構造で、保守と拡張が容易です。
• 多言語対応：Python で実装されており、様々な開発環境と互換性があります。

📦 インストール

プロジェクトの依存関係管理

開発には uv パッケージマネージャーの使用をおすすめします。

uv init

または pip を使用することもできます。

uv pip install --user -r requirements.txt

デバッグサーバーの迅速な起動

uv run server.py

🔧 技術詳細

主要コンポーネント

• API クライアント：Argo CD API との通信を実現します。
• データモデル：Argo CD サービスとのデータ交換用の構造体を定義します。
• ツールモジュール：
  • セッションツール：ユーザー情報の取得に使用します。
  • アプリケーション管理ツール：アプリケーションの CRUD 操作を処理します。
  • 設定ツール：サーバーの設定パラメータを管理します。
  • バージョン情報ツール：Argo CD のバージョンデータを提供します。

💻 使用例

基本的な使用法

クイックスタートサンプル

1. デバッグサーバーを起動します。

uv run server.py

2. MCP Inspector を使用してデバッグします。

http://localhost:5173

3. ヘルプ情報を取得します。

/help

4. ツール操作を実行します。

/tool/{tool_name}

サンプルケース

ユーザー情報の照会

uv run -m argocd.mcp.server.cli -- tool session.get_user_info

すべてのアプリケーションの一覧表示

uv run -m argocd.mcp.server.cli -- tool applications.list_applications

高度な使用法

プロジェクト構造

コードはモジュール化された方式で組織されています。

argocd-mcp/
├── api/              # API クライアントと通信ロジック
│   ├── __init__.py
│   └── client.py     # Argo CD HTTP クライアントの実装
├── models/           # データモデルの定義
│   ├── __init__.py
│   └── applications.py # アプリケーションのデータ構造
├── tools/            # MCP ツールの実装
│   ├── __init__.py
│   ├── session.py    # セッションツール（ユーザー情報）
│   ├── applications.py # アプリケーション管理ツール
│   ├── settings.py   # サーバー設定ツール
│   └── version.py    # バージョン情報ツール
├── utils/            # ユーティリティ関数
│   ├── __init__.py
├── server.py         # メインサーバーのエントリーポイント
├── pyproject.toml    # プロジェクトの設定と依存関係管理
└── mypy.ini          # Mypy 型チェックの設定

開発ガイド

環境要件

• Python 3.12 以上
• MCP（FastMCP と開発ツールを含む）
• uv パッケージマネージャー（推奨）または pip
• Argo CD API Token

型チェック

プロジェクトは mypy を使用して静的型チェックを行い、コード品質を向上させます。

# mypy のインストール
uv pip install mypy

# 型チェックの実行
uv run -m mypy .

型チェックの設定は pyproject.toml と mypy.ini にあり、以下の厳格な型規則が適用されます。

• 未定義の型を禁止する
• Any 型の返り値に警告を出す
• 関数定義の完全性をチェックする
• 名前空間パッケージをサポートする
• モジュール固有の設定

機能拡張

新しい機能を追加するには、以下の手順に従ってください。

1. tools ディレクトリ内の適切なモジュールに新しいツールを追加します。
2. server.py で新しいツールを登録します。
3. 既存のパターンに従ってパラメーターの検証とエラー処理を行います。
4. README.md ドキュメントを更新します。
5. 新しい機能に対するテストを追加します。

トラブルシューティング

問題が発生した場合は、以下の手順を試してください。

1. サーバーのログを確認します（デフォルトでは情報ログが有効になっています）。
2. CallToolRequest タイプのリクエストを処理中 というログは情報ログであり、エラーではありません。
3. mcp dev server.py を使用すると、MCP Inspector が自動的に http://localhost:5173 でデバッグ画面を開きます。
4. サーバーのログを使用して API 呼び出しとレスポンスのデバッグを行います。
5. 自己署名証明書の問題がある場合：
   • ~/.config/uv/ssl.json で証明書検証ポリシーを INSECURE に設定します。

     uv config set --cert-validation INSECURE
     

📚 ドキュメント

• 公式ドキュメント：Argo CD API ドキュメント
• 開発者ガイド：コードの貢献方法
• 問題報告：Issues リスト

このプロジェクトを Fork して Star することで、一緒に発展させましょう！