Skip to main content
Glama

x_api_get_compliance_jobs_by_id

Fetch a specific compliance job's details by ID from X API, providing its status and response data for verification.

Instructions

Get Compliance Job by ID. Use when: Get Compliance Job by ID. 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: id (path, unknown, required). 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_by_id","arguments":{"scopeTenantId":"default","scopeUserId":"default","id":""}}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
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 carries full burden. It discloses read-only risk, required bearer token, environment-selection behavior, common failure conditions, and a safety warning about sensitive account data. This goes well beyond basic expectations.

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?

Well-structured with labeled sections, but contains redundancy: 'Use when' repeats the purpose and read-only risk is stated twice. Still appropriately sized for a complex API tool with auth context.

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?

Covers purpose, exclusions, prerequisites, environment selection, failure conditions, response shape, safety, and an example. Despite a generic response shape and two undocumented params, the description is thorough enough for an agent to select and invoke this read endpoint correctly.

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?

The description explains the role of scopeTenantId, scopeUserId, scopeAccountId, and credentialKey in auth resolution, adding value over the bare schema. However, it omits authorizationKey and preferredAuthType, and the 'id (path, unknown, required)' note is vague.

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 states 'Get Compliance Job by ID' with a specific verb and resource. It clearly distinguishes from sibling tools like x_api_get_compliance_jobs (list) and x_api_create_compliance_jobs.

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?

Provides explicit 'Use when' and 'Do not use when' sections, directing exploration to x_schema_discovery or x_query_suggestion. Also lists recommended prerequisite tools, giving clear context on when this tool is appropriate.

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