MCP Alchemy

🚀 MCP Alchemy プロジェクトドキュメント

MCP Alchemyは、Claude Desktopとデータベースのやり取りを強化するツールです。このツールを使用することで、Claudeが直接様々なデータベースにアクセスし、操作し、関連するデータ情報を取得することができます。

🚀 クイックスタート

MCP Alchemyを使用することで、Claude Desktopが直接データベースにアクセスし、操作することが可能になります。以下のセクションでは、インストール方法や機能の使い方を説明します。

📦 インストール

1. リポジトリのクローン

git clone git@github.com:runekaagaard/mcp-alchemy.git
cd mcp-alchemy
uv sync

2. 依存関係のインストール

必要に応じて、データベースドライバをインストールします。

uv pip install psycopg2-binary

3. Claude Desktopの設定

claude_desktop_config.json に以下の内容を追加します。

"command": "uv",
"args": ["run", "--directory", "/path/to/mcp-alchemy", "-m", "mcp_alchemy.server", "main"],

✨ 主な機能

ツール（Tools）

all_table_names

• データベース内のすべてのテーブル名を取得します。
• 入力：なし
• 出力：カンマ区切りのテーブル名のリスト。

users, orders, products, categories

filter_table_names

• 部分文字列に基づいてテーブルを検索します。
• 入力：q（文字列）
• 出力：一致するテーブル名。

Input: "user"
Output: "users, user_roles, user_permissions"

schema_definitions

• 指定されたテーブルの詳細なスキーマ情報を取得します。
• 入力：table_names（文字列配列）
• 出力：列名、型、主キー、外部キー関係、およびNULL許容フラグなどのテーブル定義。

users:
    id: INTEGER, primary key, autoincrement
    email: VARCHAR(255), nullable
    created_at: DATETIME
    
    Relationships:
      id -> orders.user_id

execute_query

• SQLクエリを実行し、垂直形式で結果を出力します。
• 入力：query（文字列）、オプションの params（オブジェクト）
• 出力：整然とした垂直形式の結果。大きな結果セットのスマートなトランケートと、完全なコンテキストウィンドウ外のデータアクセスをサポートします。

1. 行
id: 123
name: John Doe
created_at: 2024-03-15T14:30:00
email: NULL

Result: 1 rows

環境変数（Environment Variables）

• DB_URL：SQLAlchemyデータベースURL（必須）。
• CLAUDE_LOCAL_FILES_PATH：完全な結果セットのディレクトリパス（オプション）。
• EXECUTE_QUERY_MAX_CHARS：最大出力長（オプション、デフォルトは4000）。

📚 ドキュメント

API インターフェース

MCP Alchemyは、開発者がデータベース機能を呼び出すための一連のAPIインターフェースを提供しています。主なインターフェースは以下の通りです。

• すべてのテーブル名をリストする (all_table_names)
• テーブル名をフィルタリングする (filter_table_names)
• テーブルのスキーマ情報を取得する (schema_definitions)
• クエリを実行する (execute_query)

Claude Local Files との統合

claude-local-files を設定すると、MCP Alchemyは以下のことができます。

• コンテキストウィンドウ外の大きな結果セットにアクセスする。
• 詳細なレポートやビジュアル化グラフを生成する。
• 深度のあるデータ分析を実行する。
• 結果をエクスポートしてさらなる処理を行う。

開発ガイド

1. リポジトリのクローン：git clone git@github.com:runekaagaard/mcp-alchemy.git
2. 依存関係のインストール：uv sync と必要なデータベースドライバのインストールコマンドを実行します。
3. Claude Desktopの設定：上記の設定例を参考に、MCP AlchemyをClaudeに統合します。

貢献ガイド

コミュニティからの貢献を歓迎します！問題の報告、新機能の提案、ドキュメントの改善、またはコードの貢献など、どのような形でも大歓迎です。

• 問題や機能要求を提出する
• Pull Requestを提出してバグを修正または新機能を追加する
• ドキュメントを強化または使用例を共有する
• GitHub上で議論し、経験を共有する

📄 ライセンス

このプロジェクトは、Mozilla Public License Version 2.0を採用しています。

作者の他のLLMプロジェクト

• MCP Redmine：Claude DesktopでRedmineプロジェクトとタスクを管理します。
• MCP Notmuch Sendmail：Claude DesktopとNotmuchメールシステムを統合します。
• MCP Alchemy：Claude Desktopのデータベースインタラクションツール。

以上のドキュメントが、MCP Alchemyプロジェクトの理解と使用に役立つことを願っています！