List snippets
supportbee_list_snippetsThe canned replies (snippets) of the company: name, tags and text, to reuse in a reply. GET /snippets.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
supportbee_list_snippetsThe canned replies (snippets) of the company: name, tags and text, to reuse in a reply. GET /snippets.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
readOnlyHint=true already tells the agent this is a safe read, so the description does not need to re-establish that. It adds some value by naming the returned fields (name, tags, text), but discloses nothing about ordering, pagination, or whether snippets are scoped to the company versus a user. Moderate context on top of 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 tight sentence with no filler, front-loading the resource and its fields. The trailing 'GET /snippets' is mildly redundant with the tool name but still useful as an endpoint indicator.
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 parameterless, read-only list tool with no output schema, the description is nearly sufficient: it names the resource and the fields returned. It omits ordering/pagination and the sibling distinction, but nothing critical to invoking the tool correctly is missing.
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 tool takes zero parameters, so per the rubric the baseline is 4. There is nothing for the description to clarify beyond what the empty schema already conveys.
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 the specific resource (canned replies/snippets of the company) and clarifies the terminology with 'snippets', then enumerates the fields returned (name, tags, text) plus the purpose ('to reuse in a reply'). It does not explicitly distinguish itself from the neighboring supportbee_list_replies, which is a plausible source of confusion for an agent, so it falls short of 5.
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?
Usage is only implied: 'to reuse in a reply' suggests the agent fetches snippets when composing a canned answer, but there is no explicit when-to-use statement nor any exclusion or routing to supportbee_list_replies, which sounds similar but serves a different purpose. Adequate but with a clear gap.
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.