shoal-skill
v0.1.5
Published
Codex and Claude Code skill for Shoal's entity-first MCP and API workflows
Downloads
52
Maintainers
Readme
Shoal Skill and Claude/Codex Setup
This repo provides Shoal skill guidance for Claude Code and Codex, plus the hosted MCP/plugin path for Claude Code.
shoal-skillnpm package, which installs the Shoal skill into both your local Claude Code and Codex skills directoriesshoalClaude Code plugin, which points Claude Code at Shoal's hosted MCP server and bundles the same skill guidance
Skills are not MCP tools. The skill tells Claude Code how to use the available Shoal MCP tools correctly.
Recommended setup
Use the hosted Shoal MCP server:
https://api.shoal.xyz/mcpAuthentication happens through app.shoal.xyz using Shoal's hosted OAuth flow. The account must already have a valid API key with remaining quota.
For new workflows, Shoal is entity-first:
- resolve a canonical entity
- inspect relationships or references
- traverse entity timeline, media, or research
- use org routes only for compatibility
Claude Code Plugin Marketplace
Add the marketplace:
/plugin marketplace add shoalresearch/shoal-skillInstall the plugin:
/plugin install shoal@shoalresearch-toolsReload plugins:
/reload-pluginsThe plugin bundles:
- the hosted Shoal MCP connector
- the Shoal skill
Skill-only install
Install from npm:
npx shoal-skill@latestOr:
npm install -g shoal-skill
shoal-skillRecommended local setup with the CLI
If you want the local stdio MCP path, use:
npm install -g shoal-cli
shoal auth YOUR_API_KEY
shoal setupThat setup command:
- registers
shoal-mcpin Codex - registers
shoal-mcpin Claude Code - installs the Shoal skill into both clients
Current use cases the skill is optimized for
- resolve canonical crypto entities from fuzzy names or aliases
- pull entity relationships and references
- traverse scoped timelines for one entity
- inspect entity-linked media and research content
- fetch signal, radar, category, and brief surfaces
- manage webhook and export workflows when the account plan allows them
Docs
- MCP docs: https://docs.shoal.xyz/integrations/mcp
- CLI docs: https://docs.shoal.xyz/guides/cli
- API docs: https://docs.shoal.xyz
