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

这将引导您完成以下步骤：

1. 输入您的 Wordware API 密钥
2. 设置 Claude 配置（可选）

npx 命令将：

• 如果未提供配置详细信息，则提示您输入
• 创建必要的配置文件
• 设置您的本地环境以运行 Wordware 应用程序

运行 npx 命令后，您可以使用以下命令启动 MCP 服务器：

npx wordware-mcp

永久安装

如果您希望永久安装该软件包：

# 从 npm 注册表全局安装
npm install -g wordware-mcp

# 或者在您的项目中本地安装
npm install wordware-mcp

# 或者克隆此存储库并全局安装
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 应用程序

基本用法

直接使用 npx（无需安装）

您可以使用 npx 运行 wordware-mcp，而无需先安装它：

# 交互模式 - 将提示您输入所需信息
npx wordware-mcp

# 或者使用命令行参数
npx wordware-mcp --api-key your-api-key --port 3000

# 配置后启动 MCP 服务器
npx wordware-mcp start

作为全局命令

如果全局安装，您可以通过以下两种方式之一运行：

# 选项 1：首先在当前目录中创建一个 .env 文件（请参阅配置部分）
wordware-mcp

# 选项 2：直接通过命令行传递参数
wordware-mcp --api-key your-api-key --port 3000

命令行选项

选项：
  --api-key, -k <key>      Wordware API 密钥（除非在 .env 文件中，否则为必需）
  --port, -p <port>        服务器运行的端口（默认：3000）
  --help, -h               显示此帮助消息

作为项目中的一个包

// 在您的脚本中
import { startMCP } from "wordware-mcp";

// 启动 MCP 服务器
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 密钥

为了使您的 wordware 流程可以通过 MCP 访问，您需要创建一个 API 密钥。为此，请单击右上角的个人资料图片 > API 密钥 > 创建新密钥 > 复制您的密钥

创建一个应用程序

现在是发挥创造力的时候了。为您想要实现的任何目标创建一个 wordware 应用程序，或者随意从探索页面 (https://app.wordware.ai/explore) 分叉一个应用程序。

部署您的应用程序

为了使您的应用程序被触发为 MCP，您需要部署它。为此，请前往您的应用程序。您应该在右上角看到一个“部署”按钮。然后前往部署页面。

获取 app_id

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

与 Claude Desktop 一起使用

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

1. 确保已安装 Claude for Desktop

2. 修改位于以下位置的 Claude desktop 配置文件： ~/Library/Application\ Support/Claude/claude_desktop_config.json

3. 将以下内容添加到文件中：

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

完整的工作流程示例

这是一个完整的工作流程示例，可让您快速启动并运行：

1. 配置并启动 Wordware MCP

# 运行交互式设置
npx wordware-mcp

# 按照提示进行操作：
# - 输入您的 Wordware API 密钥
# - 配置 Claude 集成（如果需要）

# 配置完成后，启动服务器
npx wordware-mcp start

2. 与您的应用程序集成

启动 MCP 服务器后，您的 Wordware 应用程序将在以下位置可访问：

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

您可以通过 HTTP 请求触发您的 Wordware 流程：

// 示例：从 JavaScript 调用您的 Wordware 应用程序
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({
      // 您的输入数据在此处
      prompt: "您的 AI 模型提示",
      // 您的 Wordware 应用程序期望的任何其他参数
    }),
  });

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

3. 使用热重载进行开发

在开发过程中，您对 Wordware 应用程序所做的任何更改都将立即生效 - 只需刷新您的应用程序或发出新的 API 调用即可。

开发

如果您想为此软件包做出贡献：

# 克隆存储库
git clone https://github.com/yuhuangou/wordware-mcp.git
cd wordware-mcp

# 安装依赖项
npm install

# 构建软件包
npm run build

# 在开发模式下运行
npm run dev

许可证

MIT

故障排除

npx 的常见问题

1. 安装后“找不到命令”

   如果您在使用 npx 安装后看到 command not found：

   # 确保软件包已全局安装
   npm install -g wordware-mcp
   
   # 检查您的 npm 全局路径是否在您的 PATH 中
   npm config get prefix
   # 如果需要，将结果路径 + /bin 添加到您的 PATH
   

2. 配置问题

   如果未检测到您的配置：

   # 检查 .env 文件是否存在于当前目录中
   ls -la .env
   
   # 手动使用参数运行以绕过 .env
   npx wordware-mcp --api-key your-api-key
   

3. 连接被拒绝错误

   如果您在尝试使用您的应用程序时看到连接错误：

   # 检查服务器是否正在运行
   lsof -i :3000
   
   # 使用详细日志记录重新启动服务器
   npx wordware-mcp start --verbose
   

4. 权限问题

   如果您在使用 npx 时遇到权限错误：

   # 使用 sudo 运行（不建议作为永久解决方案）
   sudo npx wordware-mcp
   
   # 修复 npm 权限
   chown -R $(whoami) $(npm config get prefix)/{lib/node_modules,bin,share}
   

如需更多帮助，请在我们的 GitHub 存储库上提交问题。

环境变量

以下环境变量可以在 .env 文件中设置：

• PORT - 服务器运行的端口（默认：3000）
• WORDWARE_API_KEY - 您的 Wordware API 密钥