Skip to main content
Glama

Read Shared Markdown

read_share
Read-only

Fetch the raw markdown of a docs-md.com share. Accepts the share id or any docs-md.com share URL. Use it when someone gives you a docs-md.com link, for example a handoff written by another agent.

Input Schema

NameRequiredDescriptionDefault
idYesShare id (e.g. calm-river-Ab12C) or a docs-md.com share URL

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.8/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds that it accepts either a share id or any share URL and that the result is raw markdown, which is useful. It does not mention error behavior for invalid links or auth requirements, so it adds only modest context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tight sentences with the core action front-loaded and the usage trigger second. Zero wasted words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter read tool with annotations covering safety and no output schema, the description adequately covers what it returns (raw markdown) and how to invoke it. Only a note on failure modes for invalid shares is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the single parameter's description already documents both accepted forms (share id or URL). The description restates the same flexible-input behavior without adding format examples or constraints, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: 'Fetch the raw markdown of a docs-md.com share.' Clear what it does, but it does not distinguish itself from the sibling 'share_markdown', which an agent could easily confuse on name alone.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a concrete trigger: 'Use it when someone gives you a docs-md.com link, for example a handoff written by another agent.' No explicit when-not or direct alternative named, but the usage context is clear and actionable.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.