Wordware MCP

🚀 Wordware Documentation

Wordware is a tool designed to run and manage the Word AI model. With Wordware, you can effortlessly integrate your Word applications with AI and trigger various AI processes through HTTP requests.

✨ Features

• Invoke different Word applications via simple HTTP requests.
• Support hot-reload development mode for rapid iteration.
• Enable integration with Claude Desktop.
• Offer flexible configuration and extensibility.

New Features in v1.0.0

• Release the first version of Wordware.
• Add support for HTTP requests.
• Provide basic functions in the initial version.

📦 Installation

Install via npm

You can install Wordware using npm:

npm install -g wordware-mcp

Clone the Repository

If you want to modify or contribute to the code, you can clone our repository:

git clone https://github.com/yuhuangou/wordware-mcp.git
cd wordware-mcp
npm install

💻 Usage Examples

Basic Usage

Configure and Start the Wordware Service

You can configure and start the Wordware service using the following commands:

npx wordware-mcp

Follow the prompts to enter your Word API key. After completing the configuration, start the service with:

npx wordware-mcp start

Integrate with Applications

After starting the Wordware service, you can access your Word applications via the following URL:

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

For example, if your application ID is your-app-id, you can call it using the following JavaScript code:

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: "Your prompt statement",
      // Other parameters
    }),
  });

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

Configuration

Environment Variables

You can set the following environment variables in the .env file:

• PORT - Set the port on which the service runs (default: 3000).
• WORD_API_KEY - Your Word API key.

Integration with Claude Desktop

To integrate Wordware with Claude Desktop, follow these steps:

1. Ensure that you have installed the Claude Desktop application.
2. Modify the Claude Desktop configuration file ~/Library/Application\ 支持/Claude/claude_desktop_config.json.
3. Add the following content to the configuration file:

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

Complete Example Workflow

Step 1: Configure and Start the Wordware Service

# Run interactive configuration
npx wordware-mcp

# Follow the prompts to complete the following actions:
# - Enter your Word API key
# - Configure Claude integration (if required)

# After configuration, start the service
npx wordware-mcp start

Step 2: Integrate with Applications

After starting the Wordware service, you can access your Word applications via the following URL:

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

For example, if your application ID is your-app-id, you can call it using the following JavaScript code:

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: "Your prompt statement",
      // Other parameters
    }),
  });

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

Troubleshooting

Issue: Unable to Start the Wordware Service

• Check if your Word API key is correct.
• Ensure that you have installed the latest version of Node.js.
• Check the console output for more error information.

Issue: Unable to Call the Application

• Check your network connection.
• Ensure that the Wordware service is running.
• Check the console output in the browser's developer tools.

📄 License

Wordware is released under the MIT License. Refer to the LICENSE file for detailed information.

Contributing

If you're interested in Wordware, you're welcome to contribute code! Please refer to our CONTRIBUTING.md file to learn how to contribute.