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
shout_delete_session Delete an ended session you own (permanent)
shout_search_sessions Search sessions by query, tags, and status
shout_read_session Read the plain-text transcript of a session

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.2.0.tar.gz (4.0 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.2.0-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shout_run_mcp-0.2.0.tar.gz
  • Upload date:
  • Size: 4.0 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.2.0.tar.gz
Algorithm Hash digest
SHA256 10cdf8f8b2f87fa8782a30d98e386470765058cf3c6add561ce340d27856e1c5
MD5 ae1ebffd7e71495186b9c000bd12c3e6
BLAKE2b-256 9b14fa25d45496d3762d2ccdbea2fd88538cc362231dae12f6747d108c641850

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shout_run_mcp-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 4.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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0c415cdb8da1f2617ed6ba0a5c68d04253f1edb7812283a0e534bffd347213fa
MD5 646ba1d1b0b08c691935ac48809f035c
BLAKE2b-256 667505293c0422747d30517cbe7f4343aa202926b68acae9e0e1a758fbf4c417

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