Skip to main content
Glama

x_api_get_rules

Retrieve stream rules from X API. Use to fetch active rules for filtering tweets, with optional ID filters and pagination.

Instructions

Get stream rules. Use when: Get stream rules. 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: ids (query, array); max_results (query, integer); pagination_token (query, string). 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_rules","arguments":{"scopeTenantId":"default","scopeUserId":"default"}}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idsNo
max_resultsNo
scopeUserIdNo
credentialKeyNo
scopeTenantIdNo
scopeAccountIdNo
authorizationKeyNo
pagination_tokenNo
preferredAuthTypeNo
Behavior5/5

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

With no annotations, the description carries the full burden and does so thoroughly. It discloses read-only risk, required bearer token, auth resolution behavior, common failure conditions, and a safety warning about sensitive account data. This goes well beyond minimal disclosure and does not contradict any structured data.

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 long but well-structured with labeled sections for risk, permissions, environment behavior, parameter formats, response shape, failures, and recommended tools. The 'Use when: Get stream rules' line repeats the opening and adds no value, preventing a perfect score.

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

Completeness5/5

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

Despite having 9 parameters, no annotations, and no output schema, the description is remarkably complete. It includes expected response shape, common failure conditions, auth prerequisites, safety warnings, and an example invocation. This is sufficient for an agent to select and invoke the tool correctly.

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 lists ids, max_results, and pagination_token with basic formats, and adds meaningful context for scopeTenantId, scopeUserId, scopeAccountId, and credentialKey via environment-selection behavior. However, authorizationKey and preferredAuthType are not explained at all, leaving gaps for a 9-parameter tool.

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?

The description opens with 'Get stream rules,' which names a specific verb and resource and distinguishes it from closely related siblings like x_api_get_rule_counts. However, it does not elaborate on the scope or nature of the rules beyond the tool name, and the 'Use when: Get stream rules' line is purely tautological.

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

Usage Guidelines5/5

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

Explicit guidance is provided: 'Use when: Get stream rules' and a clear exclusion clause: 'Do not use when: a more specific auth/configuration tool is required... prefer x_schema_discovery or x_query_suggestion first.' It also names recommended prerequisite and follow-up tools, satisfying the when/when-not/alternatives criterion.

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