Skip to main content
Glama

x_api_get_compliance_jobs

Fetch compliance jobs from X API, filtering by required type and optional status to monitor or audit compliance data.

Instructions

Get Compliance Jobs. Use when: Get Compliance Jobs. 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: type (query, string, required); status (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_compliance_jobs","arguments":{"scopeTenantId":"default","scopeUserId":"default"}}

Input Schema

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

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

With no annotations provided, the description fully carries the transparency burden. It explicitly declares the read-only risk, bearer token prerequisite, environment-selection behavior via scopeTenantId plus exactly one of scopeUserId/scopeAccountId, and the role of credentialKey. It also lists common failure conditions, expected response shape, and a safety warning about sensitive data—extremely thorough.

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

Conciseness3/5

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

The description is organized with clear section labels and includes an example, which aids scanning. But it has redundancy: 'Use when: Get Compliance Jobs' duplicates the opening sentence, and 'Risk: read-only' is repeated in 'Safety warnings. The length could be reduced without losing information.

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 the tool's complexity (8 parameters, no output schema, no annotations), the description covers prerequisites, response shape, failure conditions, environment behavior, and a concrete example. It does not explicitly differentiate from the by-id sibling tool, and some parameter semantics are incomplete, but overall it provides a robust operational picture.

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 type and status parameter formats, and the environment-selection role of scopeTenantId/scopeUserId/scopeAccountId/credentialKey. However, it does not explain authorizationKey or preferredAuthType semantics, leaving two of the eight parameters without meaningful description.

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 begins with 'Get Compliance Jobs.' which directly restates the tool name without adding specificity. It does not clarify whether this lists all jobs or retrieves a single job, nor does it distinguish from the sibling tool x_api_get_compliance_jobs_by_id. The 'Use when' section repeats the same tautology.

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?

The 'Do not use when' section offers useful direction, telling the agent to prefer x_schema_discovery or x_query_suggestion for exploration. However, the 'Use when' is generic ('Get Compliance Jobs') and provides no explicit comparison to x_api_get_compliance_jobs_by_id or other compliance-related tools, leaving some ambiguity about the intended use case.

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