Skip to main content
Glama
Sign In

TransformPipe

by io.github.raudarlabs
OverviewDiscussionsAdmin

Read a document

tp_get_document
Read-onlyIdempotent

Returns one document from the user's TransformPipe account, by id, as its Markdown source or as rendered HTML, with its sharing details. Use it when the user asks to see, read or quote a saved document, or to work with its content. Ids come from tp_list_documents. The output is limited to 40,000 characters.

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": {
      "id": "<id>"
    },
    "name": "tp_get_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
asNoFormat to return: markdown (default) or html.
idYesDocument id from tp_list_documents.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent, non-destructive and closed-world, so the description only needs incremental value. It supplies two things annotations cannot: the 40,000-character output cap and the inclusion of sharing details alongside content. It does not say what happens on truncation (silent cut vs. error) or on an unknown id.

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?

Three short sentences, front-loaded with the verb and resource, then usage, then the size limit. Every sentence carries information the agent needs and nothing is repeated from structured fields.

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?

With no output schema, the description steps in to characterize the return payload (Markdown or HTML body plus sharing metadata) and its size boundary, which is what an agent needs before deciding to read a large document. Minor gap: truncation and error semantics for a bad id are unspecified.

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 enum plus default live in the schema, so the description only reinforces that the choice is Markdown source versus rendered HTML. No additional syntax, quoting, or id-format guidance is added beyond the schema's own wording.

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?

States a specific verb and resource ('Returns one document ... by id'), names the two output formats, and adds that sharing details come along. An agent can distinguish it from content-manipulation siblings like tp_save_document or tp_summarize_document without opening the schema.

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 an explicit trigger ('when the user asks to see, read or quote a saved document') and points to tp_list_documents as the id source, which routes the agent away from guessing ids. It stops short of stating when not to use it — e.g. preferring tp_summarize_document when the user only wants a summary.

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

All TransformPipe 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