get_widget_snippetsCopy-paste tags: the attribution script, the live-chat script, and the embeddable booking/enquiry/rental widget iframes.
| Name | Required | Description | Default |
|---|---|---|---|
| host | No | The operator's RideDesk domain (e.g. their-workspace.ridedesk.app or a custom domain). Optional — examples use a placeholder without it. |
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 valuable behavioral context by specifying the exact types of content returned (attribution script, live-chat script, embeddable iframes), making the output expected. No contradictions with annotations.
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 that immediately conveys the tool's purpose and contents. Zero wasted words; every element contributes actionable information.
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 read-only tool with one optional parameter, good annotations, and no output schema, the description fully covers what the tool returns and how to use it. The simple nature means no additional behavior needs disclosure.
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 for the single 'host' parameter is 100%, with its own description explaining it's optional and uses a placeholder. The tool description adds no additional parameter meaning beyond listing the output types, so the baseline of 3 applies.
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 clearly states the tool provides copy-paste tags for specific scripts and iframes, using a specific verb ('Get') and concrete resource types. It distinguishes itself from sibling doc/search tools by focusing on embeddable widget snippets.
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 makes the use case clear: users needing attribution, live-chat, or booking widget snippets. It does not explicitly mention alternatives or exclusions, but the sibling names (get_doc, search_docs) imply a contrast with documentation retrieval, giving clear enough context for tool selection.
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.
Each tool clearly serves a distinct purpose: listing topics, searching docs, retrieving a topic, getting an integration brief, and fetching widget code snippets. There is no overlap; an agent can easily choose the right tool.
All tools follow a consistent verb_noun pattern: list_docs, search_docs, get_doc, get_integration_brief, get_widget_snippets. The verbs (list, search, get) are standard and predictable.
Five tools is ideal for a documentation server, covering discovery (list, search) and retrieval (get) without excess. Each tool earns its place and the set is well-scoped.
The tool surface fully covers the domain: you can discover available topics, search across content, retrieve individual topics, and get specialized artifacts (briefs and snippets). There are no dead ends or missing necessary operations.