Retrieve official ConvoKit guides, section indexes, source URLs, and documentation snapshot dates for a platform to integrate SDK, UI, auth, or REST docs.
List official ConvoKit guides, section indexes, source URLs, and documentation snapshot date.
| Name | Required | Description | Default |
|---|---|---|---|
| platform | No |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false, so safety is covered. The description adds useful content context (what fields the listing carries, including a snapshot date), but says nothing about ordering, pagination, or result size for what is presumably a full catalog dump.
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?
A single front-loaded sentence with no filler; the verb and scope come first. It is appropriately sized for the tool's simplicity, though it stops short of being maximally informative.
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?
With no output schema, the description does well to enumerate the returned fields (guides, section indexes, URLs, snapshot date) and annotations cover the safety profile. However, the unmentioned `platform` filter and absence of usage/routing guidance leave gaps for a tool sitting among four related siblings.
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% and the single `platform` parameter has an enum of seven platforms, yet the description never mentions platform filtering or what it does. The description adds no meaning beyond the raw enum values, leaving a real coverage gap uncompensated.
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?
States a specific verb ("List") and resource ("official ConvoKit guides"), plus the payload it returns (section indexes, source URLs, snapshot date). This distinguishes it from get_guide and search_docs by implication (catalog listing vs. retrieval/search), though it never names those siblings explicitly.
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 when-to-use guidance, no prerequisites, and no routing to alternatives such as search_docs or get_guide, which are the obvious neighbors. An agent must infer that this is the discovery/entry-point tool from the verb "List" alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.