Skip to main content

RunWhen Platform MCP Server — exposes workspace chat, issues, SLXs, run sessions, and Tool Builder (script run/commit) to MCP clients (Cursor, Claude Desktop, etc.)

Project description

RunWhen Platform MCP

RunWhen Platform MCP Server — exposes workspace chat, issues, SLXs, run sessions, and Tool Builder (script run/commit) to MCP clients (Cursor, Claude Desktop, etc.). Published to PyPI as runwhen-platform-mcp.

Install

Requires Python 3.10+.

pip install runwhen-platform-mcp

Or from source (in a virtual environment):

git clone https://github.com/runwhen-contrib/runwhen-platform-mcp.git
cd runwhen-platform-mcp
python3 -m venv .venv
source .venv/bin/activate
pip install -e .

This installs the runwhen-mcp command inside the venv. When configuring your MCP client, use the full path to the venv entry point so the client can find it without activating the venv:

# Find the full path
which runwhen-mcp
# e.g. /Users/you/runwhen-platform-mcp/.venv/bin/runwhen-mcp

Run the MCP server

After install, use the runwhen-mcp entry point:

runwhen-mcp

Or:

python -m runwhen_platform_mcp.server

Configure Cursor

Add to .cursor/mcp.json (or global MCP settings).

If installed globally or via pip install runwhen-platform-mcp:

{
  "mcpServers": {
    "runwhen": {
      "command": "runwhen-mcp",
      "env": {
        "RW_API_URL": "https://papi.beta.runwhen.com",
        "RUNWHEN_TOKEN": "your-jwt-token",
        "DEFAULT_WORKSPACE": "your-workspace"
      }
    }
  }
}

If installed from source into a venv, use the full path to the venv's runwhen-mcp:

{
  "mcpServers": {
    "runwhen": {
      "command": "/absolute/path/to/runwhen-platform-mcp/.venv/bin/runwhen-mcp",
      "env": {
        "RW_API_URL": "https://papi.beta.runwhen.com",
        "RUNWHEN_TOKEN": "your-jwt-token",
        "DEFAULT_WORKSPACE": "your-workspace"
      }
    }
  }
}

Environment variables

Variable Required Description
RW_API_URL Yes RunWhen API base URL (e.g. https://papi.beta.runwhen.com). Agent URL is derived from this.
RUNWHEN_TOKEN Yes RunWhen API token (JWT or Personal Access Token).
DEFAULT_WORKSPACE No Default workspace name so tools don't need workspace_name every time.

See .env.example in the repo for a template.

What's in this repo

Component Path Description
MCP Server runwhen_platform_mcp/ Python package; run via runwhen-mcp or python -m runwhen_platform_mcp.server
Docs runwhen_platform_mcp/docs/ Tool Builder flow, RUNWHEN.md template/example
Rules rules/ Cursor rules for task authoring and infrastructure
Skills skills/ Skill for building RunWhen tasks end-to-end
Agents agents/ SRE, task builder, and codecollection author personas
Cursor plugin .cursor-plugin/, mcp.json Plugin metadata and MCP config for Cursor

PyPI release

Releases are built and published to PyPI via GitHub Actions when relevant paths change on main. The workflow uses runwhen-contrib/github-actions/publish-pypi with date-based versioning (YYYY.MM.DD.N). Configure PYPI_TOKEN (and optionally SLACK_BOT_TOKEN / slack_channel) in the repo secrets.

License

Apache-2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

runwhen_platform_mcp-2026.3.7.1.tar.gz (35.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

runwhen_platform_mcp-2026.3.7.1-py3-none-any.whl (36.8 kB view details)

Uploaded Python 3

File details

Details for the file runwhen_platform_mcp-2026.3.7.1.tar.gz.

File metadata

File hashes

Hashes for runwhen_platform_mcp-2026.3.7.1.tar.gz
Algorithm Hash digest
SHA256 c9328305a8ea2f857c8fee2b6efb49e4e4a00f5fcc331c653e91639f8c7e3109
MD5 d5c941125617766e7245671c3d959db1
BLAKE2b-256 59a0fdcf6f655794a0fc5d7243476bd3f0d866233246075da79a56a686d0d994

See more details on using hashes here.

File details

Details for the file runwhen_platform_mcp-2026.3.7.1-py3-none-any.whl.

File metadata

File hashes

Hashes for runwhen_platform_mcp-2026.3.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2bc7629f9cded44009bd79038ffae56f8fc8b7e4576bb50352b9b9675969f3bd
MD5 0be5bd6e037f148983a8f9644c1f942b
BLAKE2b-256 9713258310cad2f9088467f6f431f3a806291f5cffca87d4a5e2a83e00d8a677

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page