Skip to main content
Glama

Rapier - Markdown Editor & Art

Read Rapier

read
Read-onlyIdempotent

Read exact text, a heading/fence map (as:"outline") or a PNG (as:"image") of the page or of the named block, heading or lines; a drawing's block gives it at full detail, even while it is open in Draw. query finds lines here; search lists Notes. Continue next_cursor with cursor alone. Check human context and omissions before editing. state:true reports pending work and the person’s presence; after_revision with wait_ms waits for their next change. guide returns instructions; guide resource URIs are not document IDs.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "read"
  }
}

Input Schema

NameRequiredDescriptionDefault
asNo
noteNo
agentNoYour display name on acts; never grants authority.
blockNo
guideNoInstructions only; use no other read selectors and no document.
limitNo
linesNo[first, last], 1-based, inclusive.
queryNoLiteral text to find in this document.
sinceNo
stateNo
cursorNo
searchNoSearch the Notes store; "" lists all.
headingNo
historyNo
versionNo
wait_msNoBounded wait (ms) for the next human revision.
documentNoFrom open; not needed with guide.
versionsNo
return_idNo
comparisonNo
preferencesNoInclude editor preferences in state; omitted by default.
operation_idNo
after_revisionNoWith wait_ms: return when the revision passes this.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • removedInput schema / oneOf
      Removed value: -[
      -  {
      -    "propertyNames": {
      -      "not": {
      -        "enum": [
      -          "document",
      -          "note",
      -          "block",
      -          "heading",
      -          "lines",
      -          "query",
      -          "search",
      -          "as",
      -          "versions",
      -          "version",
      -          "cursor",
      -          "limit",
      -          "state",
      -          "preferences",
      -          "history",
      -          "since",
      -          "comparison",
      -          "return_id",
      -          "after_revision",
      -          "wait_ms"
      -        ]
      -      }
      -    },
      -    "required": [
      -      "guide"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "anyOf": [
      -      {
      -        "required": [
      -          "document"
      -        ]
      -      },
      -      {
      -        "required": [
      -          "cursor"
      -        ]
      -      }
      -    ],
      -    "not": {
      -      "required": [
      -        "guide"
      -      ]
      -    }
      -  }
      -]
  2. Changed3 schema fields changed
    • addedInput schema / oneOf
      Added value: +[
      +  {
      +    "propertyNames": {
      +      "not": {
      +        "enum": [
      +          "document",
      +          "note",
      +          "block",
      +          "heading",
      +          "lines",
      +          "query",
      +          "search",
      +          "as",
      +          "versions",
      +          "version",
      +          "cursor",
      +          "limit",
      +          "state",
      +          "preferences",
      +          "history",
      +          "since",
      +          "comparison",
      +          "return_id",
      +          "after_revision",
      +          "wait_ms"
      +        ]
      +      }
      +    },
      +    "required": [
      +      "guide"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "anyOf": [
      +      {
      +        "required": [
      +          "document"
      +        ]
      +      },
      +      {
      +        "required": [
      +          "cursor"
      +        ]
      +      }
      +    ],
      +    "not": {
      +      "required": [
      +        "guide"
      +      ]
      +    }
      +  }
      +]
    • addedInput schema / properties / agent / description
      Added value: +"Your display name on acts; never grants authority."
    • addedInput schema / properties / preferences
      Added value: +{
      +  "description": "Include editor preferences in state; omitted by default.",
      +  "type": "boolean"
      +}
  3. Added
  4. Removed
  5. Changed6 schema fields changed
    • addedInput schema / properties / document / description
      Added value: +"From open; not needed with guide."
    • changedInput schema / properties / guide / description
      Previous value: -"Instructions only; use no other read selectors. MCP still requires the current document from open."New value: +"Instructions only; use no other read selectors and no document."
    • addedInput schema / properties / lines / description
      Added value: +"[first, last], 1-based, inclusive."
    • addedInput schema / properties / query / description
      Added value: +"Literal text to find in this document."
    • addedInput schema / properties / search / description
      Added value: +"Search the Notes store; \"\" lists all."
    • changedInput schema / required
      Previous value: -[
      -  "document"
      -]New value: +[]
  6. Changed1 schema field changed
    • removedInput schema / allOf
      Removed value: -[
      -  {
      -    "if": {
      -      "required": [
      -        "guide"
      -      ]
      -    },
      -    "then": {
      -      "not": {
      -        "anyOf": [
      -          {
      -            "required": [
      -              "note"
      -            ]
      -          },
      -          {
      -            "required": [
      -              "block"
      -            ]
      -          },
      -          {
      -            "required": [
      -              "heading"
      -            ]
      -          },
      -          {
      -            "required": [
      -              "lines"
      -            ]
      -          },
      -          {
      -            "required": [
      -              "query"
      -            ]
      -          },
      -          {
      -            "required": [
      -              "search"
      -            ]
      -          },
      -          {
      -            "required": [
      -              "as"
      -            ]
      -          },
      -          {
      -            "required": [
      -              "versions"
      -            ]
      -          },
      -          {
      -            "required": [
      -              "version"
      -            ]
      -          },
      -          {
      -            "required": [
      -              "cursor"
      -            ]
      -          },
      -          {
      -            "required": [
      -              "limit"
      -            ]
      -          },
      -          {
      -            "required": [
      -              "state"
      -            ]
      -          },
      -          {
      -            "required": [
      -              "history"
      -            ]
      -          },
      -          {
      -            "required": [
      -              "since"
      -            ]
      -          },
      -          {
      -            "required": [
      -              "comparison"
      -            ]
      -          },
      -          {
      -            "required": [
      -              "return_id"
      -            ]
      -          },
      -          {
      -            "required": [
      -              "after_revision"
      -            ]
      -          },
      -          {
      -            "required": [
      -              "wait_ms"
      -            ]
      -          }
      -        ]
      -      }
      -    }
      -  }
      -]
  7. Added
  8. Removed
  9. Added

TDQS

B3.4/5.0
Behavior4/5

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

Beyond the read-only annotations, the description discloses that drawing blocks are full detail even while open in Draw, that cursor continuation requires cursor alone, that state reports pending work and presence, and that after_revision with wait_ms waits for a human change. It leaves return format and error behavior unstated, but the annotations already cover the safety profile.

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

Conciseness3/5

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

It is compact and front-loads the core read modes, avoiding wasted prose. But the semicolon-heavy run-on structure makes a 23-parameter multi-mode tool harder to parse than necessary, reducing structural clarity.

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

Completeness2/5

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

For a 23-parameter tool with no output schema and only 39% schema description coverage, the description covers major read paths but omits too many selectors and return/pagination details to be complete. Annotations carry the safety profile, but the behavioral surface remains underdescribed.

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?

The description explains several high-value selectors: as text/outline/image, block/heading/lines, query vs search, cursor, state, wait_ms with after_revision, and guide. Yet with only 39% schema coverage and 23 parameters, many parameters are undocumented anywhere: note, agent, limit, since, history, versions, comparison, preferences, return_id, operation_id, and others. It partially compensates but leaves substantial gaps.

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 opening names a specific verb (Read) and the representations it returns (exact text, outline, image) plus targets (page, block, heading, lines). It does not explicitly differentiate from siblings such as open, show, or export, so it is clear but not fully disambiguating.

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?

It provides internal routing hints ('query finds lines here; search lists Notes', 'Continue next_cursor with cursor alone') and advises checking human context before editing. However, it does not state when to choose read over siblings like open, show, or export, nor does it give explicit exclusions.

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.