frappe_mcp_server
Frappe MCP Serverは、Frappe Frameworkの機能をAIアシスタントに提供するためのサーバーです。REST APIを通じて、ドキュメントのCRUD操作やスキーマ管理を行い、APIの使用方法を詳しく説明します。エラーハンドリングやバリデーションも充実しており、AIアシスタントがFrappeと効果的に連携できるよう設計されています。
GitHubスター
83
ユーザー評価
未評価
お気に入り
0
閲覧数
16
フォーク
40
イシュー
7
インストール方法
難易度
中級推定所要時間
10-20 分
必要な環境
Node.js 18以上Frappe 15以上インストール方法
インストール方法
前提条件
必要なソフトウェアとバージョンを明記してください。Node.js: 18.0.0以上
Frappe: バージョン15以上
APIキーとシークレット: Frappeから取得（必須）
インストール手順
1. npmを使用してインストール
bash
npm install -g frappe-mcp-server
bash
npx frappe-mcp-server
トラブルシューティング
よくある問題
問題: サーバーが起動しない 解決策: Node.jsのバージョンを確認し、依存関係を再インストールしてください。 問題: 認証エラーが発生する 解決策: APIキーとシークレットが正しく設定されているか確認してください。設定方法
設定方法
基本設定
サーバーは環境変数を使用して設定されます:FRAPPE_URL: FrappeインスタンスのURL（デフォルト: http://localhost:8000）FRAPPE_API_KEY: Frappe APIキー（必須）FRAPPE_API_SECRET: Frappe APIシークレット（必須）環境変数の設定
bash
export FRAPPE_URL="http://your-frappe-instance.com"
export FRAPPE_API_KEY="your_api_key"
export FRAPPE_API_SECRET="your_api_secret"
詳細設定
セキュリティ設定
APIキーは環境変数または安全な設定ファイルに保存
ファイルアクセス権限の適切な設定
ログレベルの調整
使用例
使用例
基本的な使用方法
MCPサーバーの基本的な使用方法を以下に示します：サーバーの起動
bash
npx frappe-mcp-server
bash
FRAPPE_URL=https://your-frappe-instance.com FRAPPE_API_KEY=your_api_key FRAPPE_API_SECRET=your_api_secret npx frappe-mcp-server
プログラムでの使用
javascript
// JavaScript例（Node.js）
const { MCPClient } = require('@modelcontextprotocol/client');
const client = new MCPClient();
await client.connect();
// ツールの実行
const result = await client.callTool('toolName', {
parameter1: 'value1',
parameter2: 'value2'
});
console.log(result);
使用ケース
AIアシスタントがFrappeアプリケーションのデータを操作するためのAPI呼び出しを行う。
Frappeのスキーマを利用して、動的にドキュメントを生成する。
エラーハンドリングを利用して、ユーザーに適切なフィードバックを提供する。
FrappeのREST APIを介して、AIアシスタントがユーザーのリクエストに基づいてデータを取得する。