describe_share_html
Return the AI-readable Share HTML guide, including routes and safety model.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Return the AI-readable Share HTML guide, including routes and safety model.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections. Dates show when Glama detected each change.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description must carry full burden. It discloses the tool returns a guide but does not mention idempotency, auth requirements, side effects, or data freshness. Minimal transparency.
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?
Single sentence, front-loaded with the core action and content. Efficient and no wasted words.
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?
Sufficient for a simple documentation retrieval tool. Describes return content (routes and safety model). Lacks specification of format or level of detail, but adequate given no output schema.
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?
No parameters exist, and schema coverage is 100%. Description correctly adds no parameter info. Baseline 4 is appropriate as there is no need to compensate for undocumented params.
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 returns an AI-readable Share HTML guide covering routes and safety model. Verb 'Return' specifies action, resource is 'Share HTML guide', which distinguishes it from siblings create_share and get_public_share.
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 guidance on when to use this tool versus siblings or alternatives. Implicitly it is for retrieving documentation, but lacks explicit when-to-use or when-not-to-use instructions.
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 has a distinct purpose: creating a share, retrieving a guide, and fetching metadata. No overlap or ambiguity.
Most tools follow verb_noun pattern (create_share, get_public_share), but 'describe_share_html' uses a descriptive prefix instead of a straightforward verb. Minor inconsistency.
Three tools is on the lower end but still reasonable for a focused service. Each tool serves a clear need without being sparse.
The set covers creation and retrieval but lacks update, delete, or listing capabilities. Users cannot manage or remove existing shares, which is a significant gap.