Skip to main content
Glama

x_api_update_rules

Update stream rules on X to control real-time tweet filtering. Apply changes with validated scoped credentials and payload.

Instructions

Update stream rules. Use when: Update 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: mutating, high-risk. 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: dry_run (query, boolean); delete_all (query, boolean); body is used for the documented request payload. 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_upsert_principal_credentials, x_api_request. Safety warnings: This mutates X state. Validate scope, payload, and authorizationKey before use. Example: {"name":"x_api_update_rules","arguments":{"scopeTenantId":"default","scopeUserId":"default","body":{}}}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyNo
dry_runNo
delete_allNo
scopeUserIdNo
credentialKeyNo
scopeTenantIdNo
scopeAccountIdNo
authorizationKeyNo
preferredAuthTypeNo
Behavior4/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 well: it discloses mutating/high-risk nature, bearer token requirement, tenant/credential selection behavior, common failures, and safety warnings. However, the 'bearer token' prerequisite seems to conflict with the schema's preferredAuthType enum allowing OAuth types, and the exact mutation semantics (add/replace/delete) are not described, preventing a perfect score.

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 labeled sections and is dense with useful information. The redundant 'Use when: Update stream rules.' line wastes a bit of space, but every other sentence contributes. It is longer than the TDQS examples but justified by the absence of annotations and the tool's complexity.

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?

Given no annotations, no output schema, and 9 parameters, the description is quite complete: it provides expected response shape, failure conditions, prerequisites, safety warnings, and an example. It lacks full parameter coverage (preferredAuthType) and does not explain the relationship to stream rule retrieval, but overall it covers the essential context well.

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?

Schema coverage is 0%, so the description must compensate. It explains dry_run, delete_all, body, scopeTenantId, scopeUserId, scopeAccountId, and credentialKey reasonably well, but omits preferredAuthType and does not detail the body structure. The description adds meaning beyond the schema for most parameters, but not all.

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 clearly states 'Update stream rules', identifying the specific action and resource, which distinguishes it from getter tools like x_api_get_rules. However, the 'Use when' line repeats the same phrasing and adds no additional clarity, and the description does not elaborate on what 'update' entails beyond the name.

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

Usage Guidelines4/5

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

It provides explicit when-not-to-use guidance, recommending x_schema_discovery or x_query_suggestion for exploration, and mentions when a more specific auth/configuration tool is needed. It also lists recommended prerequisite/follow-up tools. However, the 'Use when' is tautological and there is no direct comparison with rule-related tools like x_api_get_rules, so it falls short of a 5.

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