preview_subset
Create a PDF-only preview using Subset.txt, limiting content to speed up preview generation.
Instructions
Generate a faster PDF-only preview using Subset.txt.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes |
Create a PDF-only preview using Subset.txt, limiting content to speed up preview generation.
Generate a faster PDF-only preview using Subset.txt.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Since no annotations are provided, the description carries the full burden of behavioral disclosure. It mentions that the preview is 'faster' and 'PDF-only', which is somewhat behavioral, but it does not mention whether this is a write operation, if it requires authorization, if it is destructive, or what side effects it has (e.g., does it create a file?). For a tool that could be nondeterministic, more detail is needed.
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 sentence, which is concise and front-loaded with the core purpose. It includes a key qualifier ('PDF-only') and a hint about the mechanism ('using Subset.txt'). There is no extraneous information, so it is efficient, though it could be slightly more informative without losing conciseness.
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?
The tool has a single parameter and no output schema, so the description is the only source of context. Given the presence of sibling preview tools (preview_book, preview_single, preview_course), the description should explain what 'subset' means, how it differs from full previews, and what the output will be. It lacks these details, making it incomplete for an agent to use correctly without additional assumptions.
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 schema has one parameter, 'slug', with no description and 0% coverage. The description does not explain what 'slug' means in this context (e.g., is it a book slug, a course slug?) or what format it should be in. The description references 'Subset.txt' but does not link it to the parameter. The agent must infer that 'slug' identifies the subset, which is a significant gap given the lack of schema documentation.
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 verb ('Generate') and a resource ('preview'), but the resource is vague—'preview' could refer to any of the sibling preview tools. It mentions 'PDF-only' and 'using Subset.txt', which adds specificity, but it does not clearly distinguish it from preview_book or preview_single. It is not a tautology, but the purpose could be clearer.
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 description gives a hint about when to use it: 'faster PDF-only preview' and 'using Subset.txt', implying it is for a quick subset preview, but it does not explicitly state when to choose this over preview_book or preview_single, nor when not to use it. There is no mention of alternatives or exclusions, so an agent might not know the differentiator.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.