Skip to main content
Glama

x_api_get_usage

Retrieve usage data for X API calls by specifying tenant and user scopes. Monitor API consumption and identify trends within a selected time period.

Instructions

Get usage. Use when: Get usage. Do not use when: a more specific auth/configuration tool is required before the API call or you are only exploring; prefer x_schema_discovery or x_query_suggestion first. Risk: read-only. Required permissions and prerequisites: bearer token Environment-selection behavior: scopeTenantId plus exactly one of scopeUserId or scopeAccountId choose the Vault/Postgres tenant principal used for auth resolution. credentialKey selects a non-default stored credential profile when present. Parameter formats and constraints: days (query, integer). Expected response shape: { ok, status, data: { method, path, url, status, contentType, authType, data } } Common failure conditions: missing scoped credentials in Vault, missing required API parameters, X API auth failures, rate limits, or unsupported multipart/body shape. Recommended prerequisite and follow-up tools: x_connection_info, x_schema_discovery, x_auth_get_scope_credentials, x_api_request. Safety warnings: This is read-only, but responses can still include sensitive account data depending on granted scopes. Example: {"name":"x_api_get_usage","arguments":{"scopeTenantId":"default","scopeUserId":"default"}}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
daysNo
scopeUserIdNo
credentialKeyNo
scopeTenantIdNo
scopeAccountIdNo
authorizationKeyNo
preferredAuthTypeNo
Behavior5/5

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

With no annotations, the description takes on full behavioral disclosure. It states 'Risk: read-only', describes environment-selection behavior for scopeTenantId/scopeUserId/scopeAccountId, explains credentialKey profile selection, and lists common failure conditions and safety warnings. This goes well beyond the schema and provides the agent with a solid understanding of the tool's runtime behavior.

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?

The description is well-structured with clear labeled sections and an example, which aids readability. However, 'Use when: Get usage' is redundant with the tool name, and the read-only risk is repeated in both the Risk line and Safety warnings. It could be tightened without losing information.

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

Completeness3/5

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

The description covers many aspects—prerequisites, environment selection, failure conditions, response shape, and safety—which is substantial for a tool with no output schema. However, it fails to state what 'usage' actually means (e.g., API call counts, quota consumption, billing), leaving the tool's core responsibility ambiguous. Given the complexity and lack of output schema, this gap prevents full contextual completeness.

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

Parameters3/5

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

Schema description coverage is 0%, so the description must compensate. It explains the auth resolution semantics for scopeTenantId, scopeUserId, scopeAccountId, and credentialKey, and notes days as integer. However, it omits authorizationKey and preferredAuthType entirely, and does not mention that days can also accept a numeric string per the schema. Thus it only partially compensates.

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

Purpose2/5

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

The description opens with 'Get usage,' which merely restates the tool name without specifying what 'usage' refers to (e.g., API usage metrics). The subsequent details like 'X API auth failures' and response shape imply it retrieves API usage, but the primary purpose statement is tautological and does not distinguish this from the many sibling x_api_* tools.

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?

'Use when: Get usage' provides no concrete scenario. However, it does offer explicit 'Do not use when' guidance (exploration → prefer x_schema_discovery or x_query_suggestion) and lists recommended prerequisite/follow-up tools (x_connection_info, x_auth_get_scope_credentials, x_api_request). This gives some decision support, but the actual use case remains vague.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/LesterAJohn/X-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server