N8n MCP Server Bpj

🚀 n8n MCP サーバー

このサーバーは、モデルコンテキストプロトコル（MCP）を用いて、AI アシスタントが自然言語で n8n ワークフローとやり取りできるようにするものです。

🚀 クイックスタート

この MCP サーバーは、AI アシスタントが n8n ワークフローを管理し、その実行を制御するためのツールとリソースを提供します。具体的には、以下の操作が可能です。

• ワークフローの一覧表示、作成、更新、削除
• ワークフローの有効化と無効化
• ワークフローの実行と状態の監視
• ワークフロー情報と実行統計の取得

✨ 主な機能

• ワークフローの管理機能：一覧表示、作成、更新、削除が可能です。
• ワークフローの有効化と無効化：必要に応じてワークフローを有効または無効にできます。
• ワークフローの実行と監視：ワークフローを実行し、その状態を監視できます。
• ワークフロー情報と実行統計の取得：ワークフローの詳細情報と実行統計を取得できます。

📦 インストール

前提条件

• Node.js 18 以上
• API アクセスが有効な n8n インスタンス

npm からのインストール

npm install -g n8n-mcp-server

ソースコードからのインストール

# リポジトリをクローン
git clone https://github.com/leonardsellem/n8n-mcp-server.git
cd n8n-mcp-server

# 依存関係をインストール
npm install

# プロジェクトをビルド
npm run build

# オプション：グローバルにインストール
npm install -g .

📚 ドキュメント

設定

サーバーを実行するディレクトリに .env ファイルを作成し、.env.example をテンプレートとして使用します。

cp .env.example .env

以下の環境変数を設定します。

• N8N_API_URL: n8n インスタンスの URL（例: http://localhost:3000）
• N8N_API_KEY: n8n の API キー

💻 使用例

基本的な使用法

ワークフロー管理

const result = await useWorkflowList();
// すべてのワークフローのリストを返す

const workflow = await useWorkflowGet('id');
// 特定のワークフローの詳細情報を取得

const new_workflow = {
  name: 'New Workflow',
  nodes: [],
  edges: []
};
const result = await useWorkflowCreate(new_workflow);
// 新しいワークフローを作成

const updated_workflow = {
  id: 'workflow-id',
  name: 'Updated Workflow'
};
const result = await useWorkflowUpdate('workflow-id', updated_workflow);
// 既存のワークフローを更新

await useWorkflowDelete('workflow-id');
// ワークフローを削除

実行管理

const data = {
  input: 'Hello, World!'
};
const execution_result = await useExecutionRun('workflow-id', data);
// API を介してワークフローを実行

const webhook_result = await useRunWebhook('webhook-id', {
  prompt: 'トリガーするウェブフック'
});
// ウェブフックを介してワークフローを実行

await useExecutionStop('execution-id');
// 実行中の処理を停止

リソースアクセス

const result = await getResource('n8n://workflows/list');
// すべてのワークフローのリストを取得

const workflow_details = await getResource(`n8n://workflow/${workflowId}`);
// 特定のワークフローの詳細情報を取得

const execution_list = await getResource(`n8n://executions/${workflowId}`);
// ワークフローのすべての実行を取得

const execution_details = await getResource(`n8n://execution/${executionId}`);
// 特定の実行の詳細情報を取得

🔧 技術詳細

ビルド

npm run build

開発モードでの実行

npm run dev

テスト

npm test

コード規約

npm run lint

📄 ライセンス

MIT