Dev Kit MCP Server

🚀 Dev-Kit MCP Server

このパッケージは、エージェント開発ツール向けのModel Context Protocol (MCP) サーバーで、ルートプロジェクトディレクトリ内でスコープ付きの承認済み操作を提供します。makefileコマンドの実行やファイルの移動、削除などの操作を安全に実行でき、将来的にはコード編集用のツールも追加予定です。VS-Code copilotやその他のAI支援開発ツールに最適なMCPサーバーです。

✨ 主な機能

• 🔒 安全な操作：スコープ付きの承認済みルートディレクトリ内で操作を実行します。
• 🛠️ Makefileコマンドの実行：プロジェクト内で安全にmakefileコマンドを実行します。
• 📁 ファイル操作：承認済みディレクトリ内でファイルの移動、作成、名前変更、削除を行います。
• 🔄 Git操作：status、add、commit、push、pull、checkoutなどのGit操作を実行します。
• 🔌 MCP統合：任意のコードベースをMCP準拠のシステムに変換します。
• 🤖 AI支援開発：VS-Code copilotやその他のAIツールとの統合に最適です。
• 🔄 拡張可能なフレームワーク：コード編集やその他の操作のための新しいツールを簡単に追加できます。
• 🚀 高速なパフォーマンス：FastMCPを使用して構築され、高性能を実現します。

📦 インストール

pip install dev-kit-mcp-server

💻 使用例

サーバーの起動

# 推奨方法（ルートディレクトリを指定）
dev-kit-mcp-server --root-dir=workdir

# 事前定義されたコマンドのカスタムTOMLファイルを使用
dev-kit-mcp-server --root-dir=workdir --commands-toml=custom_commands.toml

# 代替方法
uv run python -m dev_kit_mcp_server.mcp_server --root-dir=workdir
python -m dev_kit_mcp_server.mcp_server --root-dir=workdir

--root-dirパラメータは、ファイル操作が実行されるディレクトリを指定します。これはセキュリティ上の理由から重要で、ファイル操作をこのディレクトリに限定します。

--commands-tomlパラメータを使用すると、デフォルトのpyproject.tomlファイルの代わりに、事前定義されたコマンドのカスタムTOMLファイルを指定できます。異なる目的のために別のコマンドセットを定義する場合に便利です。

利用可能なツール

サーバーは以下のツールを提供します。

ファイル操作

• create_dir：承認済みのルートディレクトリ内にディレクトリを作成します。
• edit_file：指定された開始行と終了行の間の行を新しいテキストで置き換えてファイルを編集します。
• move_dir：承認済みのルートディレクトリ内でファイルやディレクトリを移動します。
• remove_file：承認済みのルートディレクトリ内のファイルを削除します。
• rename_file：承認済みのルートディレクトリ内のファイルやディレクトリの名前を変更します。

Git操作

• git_status：Gitリポジトリのステータス（変更されたファイル、追跡されていないファイルなど）を取得します。
• git_add：ファイルをGitインデックス（ステージングエリア）に追加します。
• git_commit：変更をGitリポジトリにコミットします。
• git_push：変更をリモートのGitリポジトリにプッシュします。
• git_pull：リモートのGitリポジトリから変更をプルします。
• git_checkout：Gitリポジトリでブランチをチェックアウトまたは作成します。
• git_diff：コミット間、コミットと作業ツリー間などの差分を表示します。

Makefile操作

• exec_make_target：プロジェクト内で安全にmakefileコマンドを実行します。

事前定義されたコマンド

• predefined_commands：TOMLファイル（デフォルト: [tool.dkmcp.commands]セクションの下のpyproject.toml）から事前定義されたコマンドを実行します。

事前定義されたコマンドのTOMLファイル形式は以下の通りです。

[tool.dkmcp.commands]
test = "uv run pytest"
lint = "ruff check"
check = "uvx pre-commit run --all-files"
doctest = "make doctest"

各コマンドはキーと値のペアとして定義され、キーはコマンド名、値は実行するコマンドです。たとえば、事前定義されたコマンド "test" を呼び出すと、ルートディレクトリで "uv run pytest" が実行されます。

以下は、カスタムTOMLファイルでコマンドを定義する簡単な例です。

# custom_commands.toml
[tool.dkmcp.commands]
# 基本コマンド
hello = "echo Hello, World!"
date = "date"

# 開発コマンド
test = "pytest"
lint = "ruff check ."
build = "python setup.py build"

MCPクライアントを使用した例

from fastmcp import Client
async def example():
    async with Client() as client:
        # 利用可能なツールをリストする
        tools = await client.list_tools()

        # ファイル操作
        # ディレクトリを作成する
        result = await client.call_tool("create_dir", {"path": "new_directory"})

        # ファイルを移動する
        result = await client.call_tool("move_dir", {"path1": "source.txt", "path2": "destination.txt"})

        # ファイルを削除する
        result = await client.call_tool("remove_file", {"path": "file_to_remove.txt"})

        # ファイルの名前を変更する
        result = await client.call_tool("rename_file", {"path": "old_name.txt", "new_name": "new_name.txt"})

        # ファイルを編集する
        result = await client.call_tool("edit_file", {
            "path": "file_to_edit.txt",
            "start_line": 2,
            "end_line": 4,
            "text": "This text will replace lines 2-4"
        })

        # Git操作
        # リポジトリのステータスを取得する
        result = await client.call_tool("git_status")

        # ファイルをインデックスに追加する
        result = await client.call_tool("git_add", {"paths": ["file1.txt", "file2.txt"]})

        # 変更をコミットする
        result = await client.call_tool("git_commit", {"message": "Add new files"})

        # リモートから変更をプルする
        result = await client.call_tool("git_pull", {"remote": "origin", "branch": "main"})

        # リモートに変更をプッシュする
        result = await client.call_tool("git_push")

        # ブランチをチェックアウトする
        result = await client.call_tool("git_checkout", {"branch": "feature-branch", "create": True})

        # Makefile操作
        # makefileコマンドを実行する
        result = await client.call_tool("exec_make_target", {"commands": ["test"]})

        # 事前定義されたコマンド
        # 事前定義されたコマンドを実行する
        result = await client.call_tool("predefined_commands", {"command": "test"})

        # パラメータ付きで事前定義されたコマンドを実行する
        result = await client.call_tool("predefined_commands", {"command": "test", "param": "specific_test"})

📚 ドキュメント

セットアップ

# リポジトリをクローンする
git clone https://github.com/DanielAvdar/dev-kit-mcp-server.git
cd dev-kit-mcp-server

# 開発用の依存関係をインストールする
pip install -e ".[dev]"

# テストを実行する
pytest

コントリビューション

コントリビューションは大歓迎です！プルリクエストを送信してください。

📄 ライセンス

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