wordware-mcp

wordware-mcp

Wordware MCP（Model Context Protocol）サーバーを使うと、Wordware アプリをローカルで実行できます。これにより、Wordware の強力な AI フローをローカルの開発環境に直接統合でき、Wordware の機能を活用したアプリケーションのテストや開発が容易になります。

バージョン 1.1.5 の新機能

• 新しいローカル API エンドポイント（http://localhost:9000/{WORDWARE_API_TOKEN}）に対応
• APP_ID を指定する必要がなくなりました。ツールは自動的に検出されます
• npx wordware-mcp を使った対話型インストールプロセス
• Claude の設定を自動セットアップ
• コマンドライン引数に対応した、機能強化版 CLI インターフェース
• パラメーターで API キーを直接指定
• エラー処理とログを改善
• シンプルなコマンド構文でのグローバルインストールに対応

インストール

最も簡単に始める方法は、npx を使った対話型インストールプロセスです。

npx wordware-mcp

次の設定を順番に行います。

1. Wordware API キーを入力
2. Claude の設定（任意）

npx コマンドでは、次の処理が行われます。

• 設定が指定されていない場合、設定の詳細を確認します
• 必要な設定ファイルを作成します
• Wordware アプリを実行するローカル環境をセットアップします

npx コマンドの実行後、次のコマンドで MCP サーバーを起動できます。

npx wordware-mcp

永続的なインストール

パッケージを永続的にインストールする場合は、次のコマンドを実行します。

# Install globally from npm registry
npm install -g wordware-mcp

# Or install locally in your project
npm install wordware-mcp

# Or clone this repository and install globally
git clone https://github.com/{username}/wordware-mcp.git
cd wordware-mcp
npm run install-global

前提条件

このパッケージを使用するには、次のものが必要です。

1. Wordware アカウント（wordware.ai で登録してください）
2. Wordware API キー
3. デプロイ済みの Wordware アプリを 1 つ以上

基本的な使い方

npx で直接実行する（インストール不要）

事前にインストールせずに、npx を使って wordware-mcp を実行できます。

# Interactive mode - will prompt for required information
npx wordware-mcp

# Or with command line parameters
npx wordware-mcp --api-key your-api-key --port 3000

# Start MCP server after configuration
npx wordware-mcp start

グローバルコマンドとして実行する

グローバルにインストールした場合は、次のいずれかの方法で実行できます。

# Option 1: Create an .env file in your current directory first (see Configuration section)
wordware-mcp

# Option 2: Pass parameters directly via command line
wordware-mcp --api-key your-api-key --port 3000

コマンドラインオプション

Options:
  --api-key, -k <key>      Wordware API key (required unless in .env file)
  --port, -p <port>        Port to run the server on (default: 3000)
  --help, -h               Show this help message

プロジェクトのパッケージとして使用する

// In your script
import { startMCP } from "wordware-mcp";

// Start the MCP server
startMCP();

設定

MCP サーバーは、次の 2 つの方法で設定できます。

1. 環境変数または .env ファイル

次の変数を含む .env ファイルを作成します。

WORDWARE_API_KEY=your-api-key
PORT=3000

2. コマンドライン引数

コマンドの実行時に、設定を直接渡します。

wordware-mcp -k your-api-key -p 3000

Wordware のセットアップ

アカウントを作成する

まず、Wordware アカウントが必要です。wordware.ai にアクセスしてサインインし、アカウントを作成してください。

API キーを作成する

MCP 経由で Wordware のフローにアクセスするには、API キーを作成する必要があります。右上のプロフィール画像をクリックし、API keys > Create a new key の順に選択して、キーをコピーしてください。

アプリを作成する

ここからは自由に作成できます。実現したいことに合わせて Wordware アプリを作成するか、explore ページ（https://app.wordware.ai/explore）からアプリをフォークしてください。

アプリをデプロイする

アプリを MCP として呼び出せるようにするには、デプロイする必要があります。アプリに移動すると、右上に「Deploy」ボタンが表示されます。それをクリックして、デプロイページに移動してください。

app_id を取得する

デプロイページに、デプロイ URL（https://app.wordware.ai/explore/apps/{app_id}）が表示されます。そこから app_id を取得してください。

Claude Desktop での使用

この MCP サーバーを Claude Desktop で使用するには、次の手順に従ってください。

1. Claude for Desktop がインストールされていることを確認します

2. 次の場所にある Claude デスクトップ設定ファイルを編集します。 ~/Library/Application\ Support/Claude/claude_desktop_config.json

3. ファイルに次の内容を追加します。

{
  "mcpServers": {
    "wordware": {
      "command": "wordware-mcp"
    }
  }
}

ワークフローの全体例

すぐに使い始めるためのワークフロー全体の例を紹介します。

1. Wordware MCP を設定して起動する

# Run the interactive setup
npx wordware-mcp

# Follow the prompts to:
# - Enter your Wordware API key
# - Configure Claude integration (if desired)

# Once configured, start the server
npx wordware-mcp start

2. アプリケーションに統合する

MCP サーバーを起動すると、Wordware アプリに次の場所からアクセスできます。

http://localhost:3000/api/run/{app_id}

HTTP リクエストで Wordware のフローを呼び出せます。

// Example: Calling your Wordware app from JavaScript
async function callWordwareApp() {
  const response = await fetch("http://localhost:3000/api/run/your-app-id", {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      // Your input data here
      prompt: "Your prompt to the AI model",
      // Any other parameters your Wordware app expects
    }),
  });

  const result = await response.json();
  console.log(result);
}

3. ホットリロードを利用した開発

開発中に Wordware アプリに加えた変更は、すぐに利用できます。アプリを更新するか、新しい API 呼び出しを行ってください。

開発

このパッケージに貢献する場合は、次の手順に従ってください。

# Clone the repository
git clone https://github.com/yuhuangou/wordware-mcp.git
cd wordware-mcp

# Install dependencies
npm install

# Build the package
npm run build

# Run in development mode
npm run dev

ライセンス

MIT

トラブルシューティング

npx でよくある問題

1. インストール後に「Command not found」と表示される

   npx でインストールした後に command not found と表示される場合：

   # Make sure the package is installed globally
   npm install -g wordware-mcp
   
   # Check your npm global path is in your PATH
   npm config get prefix
   # Add the resulting path + /bin to your PATH if needed
   

2. 設定の問題

   設定が検出されない場合：

   # Check if .env file exists in current directory
   ls -la .env
   
   # Manually run with parameters to bypass .env
   npx wordware-mcp --api-key your-api-key
   

3. 接続拒否エラー

   アプリを使用しようとしたときに接続エラーが表示される場合：

   # Check if server is running
   lsof -i :3000
   
   # Restart server with verbose logging
   npx wordware-mcp start --verbose
   

4. 権限の問題

   npx で権限エラーが発生した場合：

   # Run with sudo (not recommended as permanent solution)
   sudo npx wordware-mcp
   
   # Fix npm permissions
   chown -R $(whoami) $(npm config get prefix)/{lib/node_modules,bin,share}
   

さらにサポートが必要な場合は、GitHub リポジトリにイシューを登録してください。

環境変数

.env ファイルで次の環境変数を設定できます：

• PORT - サーバーを実行するポート（デフォルト：3000）
• WORDWARE_API_KEY - お使いの Wordware API キー