Skip to main content
Glama

Save a document

tp_save_document

Saves a new document to the user's TransformPipe account and returns its id, size and, when shared, its URL. Use it when the user asks to save, keep or store content, or to publish it as a link. The source is Markdown, or HTML, CSV, TSV, JSON, plain text, RTF or ENEX named in from, converted on save. folder saves it into a folder by id or path and creates missing folders on the path. share sets who can open it: "private" (default), "link" (anyone with the URL) or "people" (the addresses in emails, who are emailed a link). A share of "link" or "people", or a folder that is shared or inside a shared folder, requires confirm: true; without it nothing is saved and the response describes what would be disclosed. replaces records the new document as the next version of an earlier one. Each call creates a new document; to change the text of an existing document, call tp_update_document.

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": {
      "markdown": "<markdown>"
    },
    "name": "tp_save_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
fromNoSource format to convert on save. Omit for Markdown. Binary files (.docx, .xlsx, .pptx, .epub, .odt, export .zip) cannot be passed as tool arguments.
nameNoFile name. Default "document.md"; converted content is stored as .md.
shareNoWho can open it: private (default), link or people.
emailsNoReader addresses when `share` is "people".
folderNoFolder to save into: an id from tp_list_folders, or a path from the top such as "Devart AI/Home" (`/` or `›` between names, case-insensitive). Missing folders on the path are created. Omit to save outside any folder.
confirmNoRequired when `share` is "link" or "people", or when `folder` is shared or inside a shared folder. Set true after the user has agreed to that audience.
markdownYesThe content to save: Markdown, or the format named in `from`.
replacesNoId of an earlier document; the new document is recorded as its next version, with its own id and link. tp_list_documents returns ids.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Annotations only declare the generic write profile (readOnlyHint=false, destructiveHint=false, idempotentHint=false); the description adds the material behavior that a link/people share or shared folder does nothing without confirm and instead returns a preview of what would be disclosed. It also discloses side effects annotations cannot express: missing folders on the path are created, conversion happens on save, and replaces produces a new id rather than mutating.

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?

Despite covering 8 parameters and several conditional rules, it is front-loaded with purpose and return value, then moves through source format, folder, sharing, the confirm gate, and versioning in order. No sentence is filler; even the per-parameter clauses encode behavior the schema does not fully carry.

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

Completeness5/5

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

For a non-idempotent write tool with no output schema, the description supplies everything an agent needs: what is created, what is returned, the confirm gate and its no-op behavior, folder auto-creation, version linkage via replaces, and the sibling to use for edits. Nothing material is left to inference.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, and the description goes beyond it primarily by explaining the cross-parameter rule that share of "link"/"people" or a shared folder requires confirm:true. The share/emails/folder semantics are largely restated from the rich schema descriptions, so the added value is real but moderate.

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?

Opens with a specific verb and resource ("Saves a new document to the user's TransformPipe account") and states the return payload (id, size, URL when shared). It explicitly distinguishes itself from the sibling tp_update_document by declaring that each call creates a new document.

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

Usage Guidelines5/5

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

Gives an explicit trigger condition ("Use it when the user asks to save, keep or store content, or to publish it as a link") and names the correct alternative for the adjacent case ("to change the text of an existing document, call tp_update_document"). The when-not is unambiguous, so an agent can route without inspecting schemas.

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.