Skip to main content
Glama

Coline

Show a doc

show_doc
Read-onlyIdempotent

Opens a doc inside the chat as Coline's paged editor, so the person can read and edit it in place. Use it when the person wants to see or work on a doc.

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": {
      "workspace": "<workspace>",
      "docId": "<docId>"
    },
    "name": "show_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
docIdYesDoc id from search, fetch or create_doc.
workspaceYesWorkspace slug from workspaces.list, e.g. "acme".

Output Schema

NameRequiredDescriptionDefault
urlYes
textYes
docIdYes
titleYes
revisionYes
textTruncatedYes

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the bar is lower; the description still adds real value by explaining that the doc opens as a paged editor in the chat where the human can read and edit in place. The apparent tension between "edit it in place" and readOnlyHint is not a contradiction — editing happens in the client UI, not through this call — but the description could have said so more plainly.

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 action and rendering mode front-loaded, followed by a single usage cue. Nothing is redundant or padded.

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?

The tool is simple, an output schema exists, and the safety profile is covered by annotations, so the description covers nearly everything needed. The one remaining gap is disambiguation from get_doc, which an agent could plausibly confuse with this tool.

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 both parameters (workspace, docId) already document their source (workspaces.list, search/fetch/create_doc) in the schema itself. The description adds no further meaning about the parameters, so the baseline 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?

The description gives a specific verb and resource ("Opens a doc") plus the mechanism ("inside the chat as Coline's paged editor"), which separates it from content-fetching siblings like get_doc or save_doc by implying in-place UI rendering. It stops short of naming any sibling explicitly, so the differentiation is implied rather than stated.

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?

"Use it when the person wants to see or work on a doc" gives a usable trigger condition, but there are no exclusions or alternatives — nothing tells the agent when to prefer get_doc/fetch over showing the doc, or what to do if the doc doesn't exist.

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.

Resources