Installation
Installation
Section titled “Installation”This guide covers all installation options for Workflow MCP.
Package Options
Section titled “Package Options”| Package | Use Case | Install Command |
|---|---|---|
@blackmesa/workflow-mcp-stdio | Local CLI usage | npm install -g @blackmesa/workflow-mcp-stdio |
@blackmesa/workflow-mcp-http | Remote deployment | npm install @blackmesa/workflow-mcp-http |
@blackmesa/workflow-mcp-core | Custom integration | npm install @blackmesa/workflow-mcp-core |
Local Installation (stdio)
Section titled “Local Installation (stdio)”For use with Claude Desktop or other local MCP clients.
-
Install the package
Terminal window npm install -g @blackmesa/workflow-mcp-stdio -
Configure your MCP client
Add to your
.mcp.jsonfile:{"mcpServers": {"workflow": {"command": "npx","args": ["@blackmesa/workflow-mcp-stdio"],"cwd": "/path/to/your/project"}}} -
Verify installation
Restart your MCP client. You should see “workflow” in the available tools.
Remote Installation (HTTP)
Section titled “Remote Installation (HTTP)”For deployment to Render, Fly.io, or your own server.
npm install @blackmesa/workflow-mcp-http
# Start the serverMCP_PORT=3000 npx @blackmesa/workflow-mcp-httpdocker run -p 3000:3000 \ -e MCP_WORKSPACE_DIR=/data \ -v ./workflow-data:/data \ blackmesa/workflow-mcpUse the hosted service at api.workflow-mcp.blackmesa.live:
https://api.workflow-mcp.blackmesa.live/mcpNo deployment required - just configure your MCP client to use this endpoint.
Environment Variables
Section titled “Environment Variables”| Variable | Default | Description |
|---|---|---|
MCP_PORT | 3000 | HTTP server port |
MCP_HOST | 0.0.0.0 | HTTP server host |
MCP_BASE_PATH | /mcp | MCP endpoint path |
MCP_WORKSPACE_DIR | process.cwd() | Working directory for session files |
MCP_OAUTH_ENABLED | false | Enable GitHub OAuth |
GITHUB_CLIENT_ID | - | GitHub OAuth client ID |
GITHUB_CLIENT_SECRET | - | GitHub OAuth client secret |
CORS_ORIGINS | * | Allowed CORS origins (comma-separated) |
Next Steps
Section titled “Next Steps”- Quick Start - Start your first workflow
- Local Deployment - stdio configuration details
- Remote Deployment - HTTP server setup