| name | scoping |
| description | Use when a user asks what an agent key can do, how Shuriken permissions work, or which scopes they need for a given integration. |
Scoping an agent key
Every agent key carries a set of scopes. A scope is a capability grant — read tokens, execute trades, read positions, deliver notifications. The server enforces scopes on every tool call and API endpoint; a call outside the granted scope fails with a structured authorization error.
Best practice: grant the minimum scopes the agent key actually needs
This is the single most important rule for agent-key scoping. For every agent key, grant only the scopes the integration actively uses — nothing speculative, nothing "just in case," nothing broader than the job requires.
Concretely:
- Start from what the integration does on its hot path, and enumerate only those capabilities.
- When in doubt, grant less and widen later if the integration errors on a missing scope.
- Create a separate agent key per integration (or per purpose) rather than one fat key reused everywhere — that way each key's scope surface stays tight.
- If a scope is required for a one-off setup step but not for steady-state operation, consider doing the setup with a broader key and then running with a narrower one.
Broader scopes are a liability: a leaked key is only as dangerous as the capabilities it carries.
Principles
- Separate read from write. Read scopes are generally safe; write/execute scopes move money or send messages and deserve more scrutiny.
- Per-integration, not per-user-role. A scope is a capability, not a persona. Reason about what the integration does, not who the user is.
Scope categories
Authoritative scope names live in the docs; these are the categories to reason about:
- Read scopes — querying token info, positions, wallet balances, alpha signals. Safe for analytics and display use cases.
- Trading scopes — planning trades, executing trades, cancelling orders. Required for any integration that moves funds.
- Delivery scopes — sending notifications (Telegram, email) on behalf of the user. Rate-limited.
- Administrative scopes — managing the user's agent keys themselves, linked wallets, etc. Typically not needed by third-party integrations.
Fetch https://docs.shuriken.trade/llms.txt for the current authoritative scope list and the exact names to pass when minting a key.
Common scope combinations
- Read-only analytics dashboard: read scopes only.
- Automated trading bot: read scopes + trading scopes.
- Notification/alert service: read scopes + delivery scopes.
- Full-service trading + notifications: read scopes + trading scopes + delivery scopes.
When a call fails on scope
The error response names the missing scope. Two valid responses:
- If the scope is genuinely needed, guide the user to rotate the key with the added scope.
- If the scope should not be needed (the call is read-only but erroring on a write scope), something in the integration is calling the wrong endpoint — investigate before granting.
Pointers
- Platform documentation (including scope reference): fetch
https://docs.shuriken.trade/llms.txt and search for "scopes"
- Related skills:
shuriken:agent-keys, shuriken:api-integration