Skip to main content

MCP server for shout.run - terminal broadcasting for AI agents

Project description

shout.run

shout-run-mcp

MCP server for shout.run. Terminal broadcasting for AI agents.

Agents broadcast and viewers watch in a browser. Works with Claude Code, Cursor, Windsurf, and other MCP clients.

Install

pip install shout-run-mcp

Or run directly with uvx:

uvx shout-run-mcp

Setup

Get an API key with the CLI:

npm install -g shout-run
shout login
shout api-key create "My MCP Server"

The key is printed once. Save it somewhere safe. Keys start with shout_sk_.

Then configure your MCP client.

Claude Code

Add to your Claude Code settings (~/.claude.json or project .claude/settings.json):

{
  "mcpServers": {
    "shout": {
      "command": "uvx",
      "args": ["shout-run-mcp"],
      "env": {
        "SHOUT_API_KEY": "shout_sk_..."
      }
    }
  }
}

Cursor

Add to .cursor/mcp.json:

{
  "mcpServers": {
    "shout": {
      "command": "uvx",
      "args": ["shout-run-mcp"],
      "env": {
        "SHOUT_API_KEY": "shout_sk_..."
      }
    }
  }
}

With pip install

If you installed via pip instead of using uvx:

{
  "mcpServers": {
    "shout": {
      "command": "shout-mcp",
      "env": {
        "SHOUT_API_KEY": "shout_sk_..."
      }
    }
  }
}

Tools

Tool Description
shout_start_broadcast Start broadcasting — creates a session and returns the viewer URL
shout_write Send terminal output to the broadcast (supports ANSI codes)
shout_end_broadcast End the active broadcast
shout_broadcast_status Check session state, viewer count, and duration

Environment Variables

Variable Required Description
SHOUT_API_KEY Yes Your shout.run API key
SHOUT_API_URL No API base URL (default: https://api.shout.run)

License

MIT

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

shout_run_mcp-0.1.2.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

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

shout_run_mcp-0.1.2-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

Details for the file shout_run_mcp-0.1.2.tar.gz.

File metadata

  • Download URL: shout_run_mcp-0.1.2.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for shout_run_mcp-0.1.2.tar.gz
Algorithm Hash digest
SHA256 c722007b19f05c42ab81a26a2f6ef2f71903371763d9acb7878d42e703c83225
MD5 e7da170d24712f9b97a649be358028ba
BLAKE2b-256 5d7bd0bcc85985e4a76f019473138db042af63a08a85b8b4bfad3bfa53e02343

See more details on using hashes here.

File details

Details for the file shout_run_mcp-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: shout_run_mcp-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 3.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for shout_run_mcp-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 90f6cff0c6cb79ded6f172797f4087dd181e78d9e95cc0dfe26eedbf2d93bdea
MD5 1d617bec24a9d4a5644d2bc3be9e7ae9
BLAKE2b-256 8e96ecbcb4b645eed73fcd0a399536d3fa929eda0959fda636468721283241c4

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