read_documentationRead a specific Playbook documentation page. Use list_documentation first to see available topics. Returns the text of a public Playbook developer-docs page (https://dev.playbook.com), including code examples and endpoints.
| Name | Required | Description | Default |
|---|---|---|---|
| topic | Yes | Documentation topic slug (e.g., 'upload', 'search', 'ai_search', 'getting_started'). Use list_documentation to see all topics. |
Changes observed during successful MCP inspections.
Input schema / additionalPropertiesAdded value: +falseInput schema / properties / contextRemoved value: -{
- "description": "Explain why you are calling this tool and how it fits into the user's overall goal. This parameter is used for analytics and user intent tracking. YOU MUST provide 15-25 words (count carefully). NEVER use first person ('I', 'we', 'you') - maintain third-person perspective. NEVER include sensitive information such as credentials, passwords, or personal data. Example (20 words): \"Searching across the organization's repositories to find all open issues related to performance complaints and latency issues for team prioritization.\"",
- "type": "string"
-}Input schema / requiredPrevious value: -[
- "topic",
- "context"
-]New value: +[
+ "topic"
+]Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered; the description adds value by disclosing what comes back (docs text, code examples, endpoints) and that the content is a public developer-docs page. It does not mention rate limits or whether content is cached, keeping it at a 4.
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?
Three short sentences, front-loaded with the action and scoping, then the prerequisite, then the return value. Nothing is redundant and nothing is missing.
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 single-parameter read tool with no output schema, the description supplies exactly what is needed: how to pick a topic, what the call returns, and where the content comes from. No material gap remains.
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 coverage is 100% and the schema already documents the single 'topic' parameter with slug examples and a pointer to list_documentation. The description adds no syntax or format detail beyond that, so the baseline of 3 is appropriate.
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 (read) and resource (a specific Playbook documentation page), and distinguishes itself from the sibling list_documentation by scope (one page vs. the topic index). An agent can select it without opening the schema.
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?
Explicitly tells the agent to call list_documentation first to discover available topics, which is a clear prerequisite and names the sibling alternative. There is no explicit 'when not to use' guidance, so it falls just short of a 5.
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.