Skip to main content
Glama

x_api_create_compliance_jobs

Creates a compliance job using X API, resolving tenant-scoped credentials and authentication automatically. Use this to submit compliance tasks with proper authorization.

Instructions

Create Compliance Job. Use when: Create Compliance Job. 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: no endpoint-specific parameters; 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_create_compliance_jobs","arguments":{"scopeTenantId":"default","scopeUserId":"default","body":{}}}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyNo
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 and does exceptionally well. It discloses the mutating, high-risk nature, required bearer token, environment-selection behavior for scope/credential resolution, common failure conditions (e.g., missing credentials, rate limits), and safety warnings about validating scope and payload before use.

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 uses labeled sections that make it scannable and information-dense. It is longer than strictly necessary—for instance, the 'Use when' line repeats the opening phrase—but each section like 'Common failure conditions' and 'Expected response shape' serves a purpose.

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 complex wrapper tool with no output schema and no annotations, the description is quite complete: it covers response shape, failure conditions, prerequisites, safety, and an example. However, it doesn't explain what a compliance job is in domain terms or what the body payload should contain, relying on 'documented request payload' as a placeholder.

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 the semantics of scopeTenantId, scopeUserId/scopeAccountId, and credentialKey, plus the role of body. However, it leaves authorizationKey and preferredAuthType unaddressed beyond the safety warning mentioning authorizationKey, so not all parameters gain additional meaning.

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 the tool creates a compliance job with the verb+resource phrase 'Create Compliance Job.' However, it does not elaborate on what a compliance job is or explicitly distinguish itself from sibling tools like x_api_get_compliance_jobs or x_api_get_compliance_jobs_by_id, though the verb 'create' does differentiate it.

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?

The description provides explicit 'Use when' and 'Do not use when' guidance, including alternatives like x_schema_discovery and x_query_suggestion for exploration. It also lists recommended prerequisite and follow-up tools, which gives an agent clear decision-making context.

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