wordware-mcp

Wordware MCP（主控制程序）服务器允许您在本地运行 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

这将指导您完成：

输入您的 Wordware API 密钥
设置 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/yuhuangou/wordware-mcp.git
cd wordware-mcp
npm run install-global

先决条件

在使用此包之前，您需要：

Wordware 帐户（在wordware.ai注册）
Wordware API 密钥
至少部署了一个 Wordware 应用

基本用法

直接使用 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 服务器：

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 密钥 > 创建新密钥 > 复制您的密钥

创建应用程序

现在是时候发挥你的创造力了。创建一个 Wordware 应用来实现你想要实现的任何目标，或者你也可以从探索页面 ( https://app.wordware.ai/explore ) 随意 fork 一个应用。

部署你的应用

要让您的应用以 MCP 模式触发，您需要进行部署。请前往您的应用。您会在右上角看到“部署”按钮。然后前往部署页面。

获取`app_id`

在部署页面上，您将看到您的部署 URL： https://app.wordware.ai/explore/apps/{app_id} 。从那里获取您的 app_id

与 Claude Desktop 一起使用

要将此 MCP 服务器与 Claude Desktop 一起使用：

确保已安装 Claude for Desktop
修改位于以下位置的 Claude 桌面配置文件： ~/Library/Application\ Support/Claude/claude_desktop_config.json
将以下内容添加到文件：

{
  "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

执照

麻省理工学院

故障排除

npx 的常见问题

安装后出现“未找到命令”如果使用 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
配置问题如果未检测到您的配置：
# 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
连接被拒绝错误如果您在尝试使用应用程序时看到连接错误：
# Check if server is running lsof -i :3000 # Restart server with verbose logging npx wordware-mcp start --verbose
权限问题如果您遇到 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 密钥

Integrations