Skip to main content
Glama

x_api_stream_users_compliance

Stream user compliance data from X API for audit and moderation. Use to retrieve compliance events with tenant-aware auth and configurable time ranges.

Instructions

Stream Users compliance data. Use when: Stream Users compliance data. 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: backfill_minutes (query, integer); partition (query, integer, required); start_time (query, string); end_time (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_stream_users_compliance","arguments":{"scopeTenantId":"default","scopeUserId":"default"}}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
end_timeNo
partitionYes
start_timeNo
scopeUserIdNo
credentialKeyNo
scopeTenantIdNo
scopeAccountIdNo
authorizationKeyNo
backfill_minutesNo
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. It discloses read-only nature, bearer token requirement, environment-selection behavior, common failure conditions, and safety warnings about sensitive data. It falls short of detailing streaming mechanics but is otherwise thorough.

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, making it easy to scan. Some redundancy ('Risk: read-only' vs 'Safety warnings: This is read-only') but no wasted sentences overall.

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?

For a tool with no annotations and no output schema, the description provides extensive context: permissions, environment behavior, failure modes, response shape, and an example. The main gap is the incomplete parameter semantics, which prevents a perfect score.

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

Parameters2/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 covers some parameters (scopeTenantId, scopeUserId, scopeAccountId, credentialKey) with behavioral context, and lists formats for four query params, but fails to explain the semantics of partition, start_time, end_time, and omits authorizationKey and preferredAuthType entirely. This is insufficient for a 10-parameter tool.

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

Purpose5/5

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

The description opens with 'Stream Users compliance data,' a specific verb+resource that clearly distinguishes this tool from sibling tools like x_api_stream_posts_compliance and x_api_stream_likes_compliance. It unambiguously states the tool's function.

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?

Provides explicit 'Use when' and 'Do not use when' guidance, including preferring x_schema_discovery or x_query_suggestion for exploration. However, it does not explicitly differentiate from other compliance stream tools, so it is not a perfect 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