get_compel
Get the current status, progress, and details of a Compeller generation job.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| compel_id | Yes | The compel ID to check |
Get the current status, progress, and details of a Compeller generation job.
| Name | Required | Description | Default |
|---|---|---|---|
| compel_id | Yes | The compel ID to check |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already signals a safe read operation. The description adds that it returns status, progress, and details, but does not disclose any additional behavioral traits such as polling behavior or response format. This is acceptable given the annotation coverage.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, front-loaded sentence with no unnecessary words. It efficiently conveys the tool's purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple get-by-ID tool with a read-only annotation and clear parameter schema, the description adequately covers what the agent needs to know. It states the type of information returned (status, progress, details) without needing to enumerate every field.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema fully documents the single parameter 'compel_id' with a description. The tool description does not add any further parameter semantics, which is acceptable given the 100% schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses the specific verb 'Get' and clearly identifies the resource as a 'Compeller generation job'. It mentions status, progress, and details, which distinguishes it from list/search operations, though it does not explicitly name sibling alternatives.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives like list_compels or search_compels. The description simply states what it does, leaving the agent to infer the appropriate use case.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
Every tool targets a distinct action or resource. Groups like compels, lighting cues, webhooks, and account are clearly separated, and even similar tools (create_compel vs create_compel_from_music) have well-defined differences in input source.
All tool names follow a consistent verb_noun pattern with underscores (e.g., cancel_compel, launch_lighting_cue, register_webhook). No mixing of conventions or ambiguous verb choices.
With 30 tools, the server is above the 25+ threshold for 'too many'. While the scope includes multiple subdomains, the high number adds cognitive load and risks selection errors for an agent.
Core workflows are present (create, read, cancel, list, search, render), but missing update/delete for compels and media, and no way to modify render configuration beyond defaults.