Skip to main content
Glama

Open a Markdown Document

render_article
Read-onlyIdempotent

Open the current saved document in the mdedit reader. Accepts natural workspace names and document titles; internal identifiers are optional. Use this contextually after creation or updates and for open, read, show, preview, export, publish, or review requests.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
focusNopreview
contextYesDescribe the user's underlying goal in one sentence. Do not include private document content, credentials, or personal information.
articleIdNoInternal document identifier when already available. Omit it when the user referred to the document by title.
workspaceIdNoOptional workspace ID to narrow document lookup. Omit when the document title or ID uniquely identifies a document across authorized workspaces.
articleTitleNoHuman-visible document title. Prefer this over asking the user for an internal document identifier.
workspaceNameNoOptional workspace name to narrow document lookup. A unique document title can be used without a workspace choice.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
focusYes
titleYes
editorUrlYes
updatedAtNo
isPublishedYes
openReviewCountYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / context
      Added value: +{
      +  "description": "Describe the user's underlying goal in one sentence. Do not include private document content, credentials, or personal information.",
      +  "type": "string"
      +}
    • changedInput schema / properties / workspaceId / description
      Previous value: -"Internal workspace identifier when already available. Omit it when the user referred to a workspace by name or has only one workspace."New value: +"Optional workspace ID to narrow document lookup. Omit when the document title or ID uniquely identifies a document across authorized workspaces."
    • changedInput schema / properties / workspaceName / description
      Previous value: -"Human-visible workspace name. Prefer this over asking the user for an internal workspace identifier."New value: +"Optional workspace name to narrow document lookup. A unique document title can be used without a workspace choice."
    • addedInput schema / required
      Added value: +[
      +  "context"
      +]
  2. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so safety is covered. The description adds the useful detail that identifiers are optional and natural names are accepted, but it never explains what 'focus' does or whether export/publish focuses trigger side effects, which sits uneasily beside readOnlyHint.

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

Conciseness4/5

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

Two front-loaded sentences: the action first, then the identifier convention and usage triggers. The trailing verb list is somewhat padded but not wasteful enough to hurt readability.

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

Completeness3/5

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

With an output schema, rich annotations, and high parameter coverage, the description does not need to cover return values. However, for a six-parameter tool with a behavior-changing 'focus' enum, it should at least route the agent away from read_article and clarify that 'focus' selects export/publish/review modes.

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 83%, so the schema largely documents the six parameters. The description only reinforces the title/name-vs-ID preference already stated in the schema; it adds nothing about the 'focus' enum or the required 'context' argument. Baseline 3 is appropriate.

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 clear verb + resource: 'Open the current saved document in the mdedit reader,' plus the accepted reference style (natural names/titles over internal IDs). It never distinguishes itself from the close sibling read_article, so an agent cannot tell which to pick from the description alone.

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 supplies trigger contexts ('after creation or updates') and a list of request types (open, read, show, preview, export, publish, review). But several of those triggers overlap directly with siblings like read_article, start_article_export, and publish_article, and there is no when-not-to-use or sibling routing, so the guidance is implied rather than decisive.

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