Skip to main content
Glama

get_api_token_scopes

Read-only

Retrieve the catalog of API token scopes grouped by resource to determine which permissions can be granted when creating or managing tokens on a Remnawave panel.

Instructions

Get available API token scopes Returns the catalog of scopes that can be granted to an API token, grouped by resource. Forbidden via "API-key", admin JWT only. [READ] GET /api/tokens/scopes

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

A3.8/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true/destructiveHint=false, and the description is consistent with them while adding genuinely useful context beyond them: the admin-JWT-only auth requirement and the grouped-by-resource shape of the payload. It does not, however, describe pagination or output structure in detail.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Compact and front-loaded, with the auth constraint and HTTP route kept short. Minor redundancy in restating the tool name ('Get available API token scopes' → 'Returns the catalog of scopes...'), but every line is useful.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema exists, and the description compensates reasonably by saying what the return value is (a scope catalog grouped by resource) and who may call it. Complete enough for a zero-parameter read tool, though it could say more about the returned fields.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool takes zero parameters, so the baseline is 4; there is nothing for the description to disambiguate beyond confirming that no input is needed.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource ('Get available API token scopes') and clarifies what the result contains: a catalog of grantable scopes grouped by resource. It is clearly distinct from the many sibling get_* tools, though it never explicitly contrasts with any of them.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides a real constraint — the endpoint is 'Forbidden via API-key, admin JWT only' — which tells the agent when the call will fail, but gives no positive guidance on when to reach for this tool versus alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools