Skip to main content
The shoal-mcp binary ships with shoal-cli and runs a Model Context Protocol server over stdio. Once registered, AI agents can call Shoal endpoints directly as native tools — no shell commands, no glue code.

Setup

Step 1 — Install the CLI and authenticate:
npm install -g shoal-cli
shoal auth YOUR_API_KEY
Step 2 — Register the MCP server with your agent:
claude mcp add --transport stdio shoal -- shoal-mcp
Or add manually to ~/.claude/settings.json:
{
  "mcpServers": {
    "shoal": {
      "command": "shoal-mcp"
    }
  }
}
Step 3 — Restart your agent. Shoal tools will appear in the tool list automatically.

Available Tools

ToolDescription
signal_topTop signal events by score
signal_allAll signal events — paginated, filterable by time
radar_allAll radar events — paginated, filterable by time
orgs_searchSearch organizations by name
orgs_getGet an org by ID with optional embedded events
brief_orgIntelligence brief for one org
brief_batchBriefs for up to 25 orgs in one call
categoriesList all event categories
usageAPI usage and quota

Example Prompts

Once registered, you can ask your agent naturally:
Get the top Shoal signals from the last 2 hours
Search for the org "Ethereum Foundation" and get a brief for the last day
Get briefs for orgs 526, 765, and 1024 — compact mode, last 8 hours
The agent will call the appropriate Shoal tools and incorporate the results directly into its response.