Retrieve a saved snippet definition, returning the published version by default or the unpublished draft when requested.
Export a known snippet definition; published version by default.
| Name | Required | Description | Default |
|---|---|---|---|
| snippet_id | Yes | ||
| unpublished_version | No |
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
v0.2.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare read-only, idempotent, and non-destructive behavior, so the description only needs to add context beyond those. It adds the default published-version behavior and the 'known' precondition, but it does not describe return behavior, error cases, or what happens when an unpublished version is requested.
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 one concise sentence with no filler. Purpose and default behavior are front-loaded, and every word contributes meaning.
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 two-parameter read-only tool with strong annotations and an output schema, the description is mostly complete. It does not explain alternative usage or elaborate on the export output, but the output schema and annotations carry that burden.
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?
Schema description coverage is 0%, so the description must compensate. 'Known snippet definition' implies the required parameter must identify an existing snippet, and 'published version by default' clarifies the meaning of the unpublished_version flag. Still, most parameter detail is left to the schema and property names.
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 states a specific action ('Export'), a specific resource ('snippet definition'), and a scope ('known', 'published version by default'). This clearly distinguishes the tool from sibling list/get/execute tools for workflows, jobs, and artifacts.
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?
The phrase 'known snippet definition' implies this tool is for exporting an already-known snippet rather than discovering or listing snippets, and the default version hint points to the unpublished_version parameter. However, it does not explicitly state when to use this tool versus alternatives or provide any exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.