n8n MCP Tools

MIT License
95
  • Linux
  • Apple

Integrations

  • Supports configuration through environment variables stored in .env files, allowing for flexible deployment and configuration of the MCP server.

  • Provides a complete implementation of n8n's Public API, enabling AI assistants to manage workflows, users, credentials, executions, tags, variables, projects, and audit functionality through natural language interactions.

  • Includes Swagger documentation for the RESTful API server, making the API endpoints discoverable and testable through a web interface.

n8n MCPツール

n8n API統合のためのモデルコンテキストプロトコル(MCP)サーバー実装。このプロジェクトは、MCPプロトコルを使用してn8nワークフローとAIアシスタント間のシームレスな統合を可能にします。

特徴

  • n8n のパブリック API (v1.1.1) の完全実装
  • すべてのAPIエンドポイント用のMCPツール
  • Swaggerドキュメント付きのRESTful APIサーバー
  • 拡張性のためのモジュール型アーキテクチャ
  • 認証ミドルウェア

構造

プロジェクトは次のコンポーネントで構成されています。

  • api/endpoints/ : 各リソースタイプのAPIエンドポイント実装
  • api/schemas/ : データモデルスキーマ定義
  • api/tools/ : 各リソースタイプのMCPツール実装
  • api/index.js : メインサーバーのエントリポイント
  • api/config.js : 構成設定

はじめる

前提条件

  • Node.js (v14以上)
  • npmまたはyarn
  • APIキーを持つn8nインスタンス

インストール

パッケージとして

# Install globally npm install -g n8n-mcp-tools # Create a .env file in your working directory echo "N8N_API_BASE_URL=https://your-n8n-instance.com/api/v1 N8N_API_KEY=your-api-key PORT=3000" > .env # Start the MCP server n8n-mcp-server

出典

  1. リポジトリをクローンします。
    git clone https://github.com/yourusername/n8n-mcp-tools.git cd n8n-mcp-tools
  2. 依存関係をインストールします:
    npm install
  3. 設定を含む.envファイルを作成します。
    N8N_API_BASE_URL=https://your-n8n-instance.com/api/v1 N8N_API_KEY=your-api-key PORT=3000
  4. サーバーを起動します。
    npm start
  5. API ドキュメントにアクセスします。
    http://localhost:3000/api-docs

MCPツール

MCPツールを使用すると、AIアシスタントが自然言語でn8nと対話できるようになります。以下にツールの例を示します。

ユーザーツール

  • get-users : n8nインスタンスからすべてのユーザーを取得する
  • get-user : IDまたはメールアドレスで特定のユーザーを取得する
  • create-users : 1人以上のユーザーを作成する
  • delete-user : IDまたはメールアドレスでユーザーを削除する
  • change-user-role : ユーザーのグローバルロールを変更する

ワークフローツール

  • get-workflows : n8nインスタンスからすべてのワークフローを取得する
  • get-workflow : IDで特定のワークフローを取得する
  • create-workflow : 新しいワークフローを作成する
  • update-workflow : 既存のワークフローを更新する
  • delete-workflow : IDでワークフローを削除する
  • activate-workflow : ワークフローをアクティブ化する
  • deactivate-workflow : ワークフローを非アクティブ化する
  • get-workflow-tags : ワークフローのタグを取得する
  • update-workflow-tags : ワークフローのタグを更新する
  • transfer-workflow : ワークフローを別のプロジェクトに転送する

さらに、資格情報、実行、タグ、変数、プロジェクト、監査機能のためのツールも多数あります。

構成

サーバーは、環境変数を使用するか、 api/config.js変更することで設定できます。

  • N8N_API_BASE_URL : n8n APIのベースURL
  • N8N_API_KEY : 認証用のAPIキー
  • PORT : サーバーを実行するポート
  • HOST : サーバーをバインドするホスト
  • LOG_LEVEL : ログレベル(情報、エラー、デバッグ)
  • MCP_SOCKET_PATH : MCPソケットのパス(STDIOトランスポート用)
  • MCP_USE_TCP : MCPトランスポートにTCPを使用するかどうか
  • MCP_TCP_PORT : MCPトランスポートのTCPポート
  • MCP_TCP_HOST : MCPトランスポートのTCPホスト

ライセンス

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

出版

このパッケージに貢献していて、新しいバージョンを公開する必要がある場合:

  1. package.json のバージョンを更新します。
    npm version patch # for bug fixes npm version minor # for new features npm version major # for breaking changes
  2. npm に公開:
    npm publish
  3. postversion スクリプトは新しいバージョンを GitHub に自動的にプッシュします。

貢献

貢献を歓迎します!詳細については貢献ガイドをご覧ください。

変更履歴

各バージョンの変更の詳細については、 CHANGELOG.mdファイルを参照してください。

-
security - not tested
A
license - permissive license
-
quality - not tested

AI アシスタントが自然言語を通じて n8n ワークフローと対話できるようにし、ワークフロー管理、ユーザー管理、資格情報の処理など、n8n の完全な API 機能へのアクセスを提供するモデル コンテキスト プロトコル サーバー。

  1. Features
    1. Structure
      1. Getting Started
        1. Prerequisites
        2. Installation
      2. MCP Tools
        1. User Tools
        2. Workflow Tools
      3. Configuration
        1. License
          1. Publishing
            1. Contributing
              1. Changelog
                ID: 6itt4az3yj