Skip to main content
Glama
Sign In

mdshare

by io.github.sathya-sankaran
OverviewDiscussionsAdmin

Read a shared document

read_document
Read-onlyIdempotent

Read an mdshare document from its share link: the markdown, its title, what the link allows (view, comment or edit), the last edit and when it expires.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "link": "<link>"
    },
    "name": "read_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
linkYesThe mdshare share link you were given, in full: https://mdshare.live/d/<id>?key=... (a view, comment or edit link; admin links are refused).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already establish read-only, idempotent, non-destructive and closed-world behavior, so the bar is lower. The description still adds genuinely useful context: reading reports what the link permits (view/comment/edit) and when the link expires, which an agent needs to decide what follow-up actions are possible.

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?

A single front-loaded sentence: verb, resource, source of the resource, then the return payload. No filler and nothing buried.

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 no output schema, the description carries the return-value burden and does so, listing the fields an agent will get back. It is complete enough to call correctly, with the only shortfall being absent sibling routing guidance.

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%, so the link parameter's format and the admin-link restriction are already documented in the schema. The description adds no format or validation detail beyond that, making a baseline 3 correct.

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

Purpose5/5

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

Concrete verb ('Read') plus resource ('mdshare document') and it goes further by enumerating what comes back: the markdown, title, link permissions, last edit and expiry. That content list also separates it in practice from get_versions and list_comments, which are named siblings with different outputs.

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

Usage Guidelines3/5

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

Implied usage is clear: open a document when you have its share link. However, it never states when to reach for get_versions or list_comments instead, and the only exclusion ('admin links are refused') lives in the schema rather than the description.

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

All mdshare toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources