Wordware MCP server for AI agents

The Wordware MCP (Model Context Protocol) server enables you to run Wordware apps locally, integrating powerful AI flows directly into your development environment for easier testing and development of applications that use Wordware's capabilities.

Installation

The easiest way to get started is using the interactive installation process:

npx wordware-mcp

This guided process will help you:

Enter your Wordware API key
Set up Claude configuration (optional)
Create necessary configuration files
Configure your local environment

After configuration, start the MCP server with:

npx wordware-mcp

Permanent Installation Options

If you prefer a permanent installation:

# Install globally
npm install -g wordware-mcp

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

Prerequisites

Before using this package, you need:

A Wordware account (sign up at wordware.ai)
A Wordware API key
At least one deployed Wordware app

Basic Usage

Using npx (No Installation Required)

# Interactive mode with prompts
npx wordware-mcp

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

# Start the server after configuration
npx wordware-mcp start

Using as a Global Command

If installed globally:

# Using a .env file in your current directory
wordware-mcp

# Or passing parameters directly
wordware-mcp --api-key your-api-key --port 3000

Command Line Options

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

Using as a Package in Your Project

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

// Start the MCP server
startMCP();

Configuration

Configure the MCP server using one of these methods:

Environment Variables or .env File

Create a .env file with:

WORDWARE_API_KEY=your-api-key
PORT=3000

Command Line Arguments

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

Setting Up Your Wordware Environment

Create an Account

Create an API Key

Click on your profile picture in the top right corner
Navigate to API keys
Create a new key
Copy your key for later use

Create and Deploy an App

Create a new Wordware app or fork an existing one from the explore page
Click the "Deploy" button in the top right corner of your app
Note your app_id from the deployment URL: https://app.wordware.ai/explore/apps/{app_id}

Using with Claude Desktop

To integrate with Claude Desktop:

Ensure Claude for Desktop is installed
Edit the Claude config file at: ~/Library/Application\ Support/Claude/claude_desktop_config.json
Add the following configuration:

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

Complete Example Workflow

1. Configure and Start the Server

# Run interactive setup
npx wordware-mcp

# Follow the prompts for configuration

# Start the server
npx wordware-mcp start

2. Integrate with Your Application

Once the server is running, access your Wordware apps at:

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

Call your Wordware app via HTTP requests:

// 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({
      prompt: "Your prompt to the AI model",
      // Additional parameters your app needs
    }),
  });

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

Troubleshooting

Common Issues

Command Not Found After Installation

# Ensure 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

Configuration Not Detected

# Check if .env file exists
ls -la .env

# Run with explicit parameters
npx wordware-mcp --api-key your-api-key

Connection Refused Errors

# Check if server is running
lsof -i :3000

# Restart with verbose logging
npx wordware-mcp start --verbose

Permissions Issues

# Fix npm permissions
chown -R $(whoami) $(npm config get prefix)/{lib/node_modules,bin,share}

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "wordware" '{"command":"wordware-mcp"}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

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

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

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

3. Restart Claude Desktop for the changes to take effect