Skip to Content
πŸŽ‰ Scout Docs 2.0 is here!
MCPScout MCP

Scout MCP

Scout MCP is a local Model Context ProtocolΒ  server that connects your coding agents to the Scout OS API. Start it locally and your agent can list workflows, create collections, run triggers, upload files, and more β€” all from inside its context window.

How It Works

Scout MCP wraps the Scout OS APIΒ  and exposes it as 13 domain tools. Each tool accepts an action parameter (list, get, create, update, delete) so your agent can operate on any Scout resource without learning a separate tool for every endpoint.

Scout MCP architecture: your coding agent communicates with scoutos-mcp via Streamable HTTP, and scoutos-mcp proxies to the Scout OS API via HTTPS

The server runs on http://127.0.0.1:9987/mcp using Streamable HTTP transport, making it compatible with any MCP-capable client.

Tool Coverage

79 Scout API endpoints are mapped to 13 domain tools:

ToolCoversActions
scout_workflowsWorkflows, revisions, environmentslist, get, create, update, delete, run, run_with_config
scout_agentsAgentslist, get, upsert, delete, interact, interact_sync
scout_agent_sessionsAgent sessionsinteract_with_session, interact_sync_with_session, interact_async_with_session
scout_collectionsCollectionslist, get, create, update, delete
scout_tablesTableslist, get, create, update, delete, get_schema, sync
scout_documentsDocumentslist, get, create, update, update_batch, delete, delete_batch
scout_syncsSyncs, sourceslist, get, create, update, delete, execute, list_sources
scout_triggersTriggerslist, create, update, delete, execute_slack, execute_telegram, execute_cron
scout_copilotsCopilotslist, get, create, update, delete
scout_logsRun logslist, get_details
scout_integrationsIntegrations, orglist, list_channels, delete_integration
scout_driveDriveupload, download
scout_usageUsageget

Resources

Read-only context resources exposed via MCP:

  • scout://workflows β€” list of workflows
  • scout://collections β€” list of collections
  • scout://agents β€” list of agents

Install and Start

Prerequisite: A Scout API key from Settings β†’ API Keys.

Install with npm:

npm install -g scoutos-mcp

Or run directly with npx:

npx scoutos-mcp

Set your API key and start the server:

export SCOUT_API_KEY="your_api_key_here" scoutos-mcp

By default, the server listens on http://127.0.0.1:9987/mcp. Customize the port or host:

scoutos-mcp --port 3333 --host 127.0.0.1

Verify it is running:

curl http://127.0.0.1:9987/health

Bearer Token Authentication

To restrict access to the MCP server, set a bearer token:

export MCP_SERVER_BEARER_TOKEN="your_secret_token"

Clients must then include this header with every request:

Authorization: Bearer your_secret_token

Environment Variables

VariableRequiredDefaultDescription
SCOUT_API_KEYYesβ€”Your Scout API key
PORTNo9987Server port
HOSTNo127.0.0.1Server host
MCP_SERVER_BEARER_TOKENNoβ€”Bearer token for client authentication

Docker

docker build -t scoutos-mcp . docker run -p 9987:9987 -e SCOUT_API_KEY=your_api_key_here scoutos-mcp

Connect Your Agent

Point your MCP-capable coding agent at the Scout MCP server URL:

http://127.0.0.1:9987/mcp

Each agent has its own way of configuring MCP server connections. Follow the setup guide for your preferred coding agent:

Example Prompts

Once Scout MCP is connected, try prompts like:

  • β€œList my Scout workflows and explain what each one does.”
  • β€œFind the agent named SDR Assistant and show its current configuration.”
  • β€œShow my collections and summarize which tables look customer-related.”
  • β€œRun the workflow <workflow-id> with a sample payload and summarize the output.”
  • β€œCheck recent Scout run logs and surface failures from today.”
  • β€œUpload this CSV to the Drive and then sync it to the customers table.”

Troubleshooting

IssueWhat to check
Agent cannot connectMake sure scoutos-mcp is running and the URL matches the configured host and port
401 or auth errorsVerify SCOUT_API_KEY is set before starting the server
Works in one agent but not anotherConfirm each agent is pointing at http://127.0.0.1:9987/mcp and reload its MCP config
Health check failsRun curl http://127.0.0.1:9987/health locally and restart the server
Bearer token errorsMake sure MCP_SERVER_BEARER_TOKEN and the client Authorization header match

References

Last updated on