Markdown by mdedit.ai

Read a Markdown Document

read_article

Read-onlyIdempotent

Read the current saved Markdown content and metadata for a document. Accepts natural workspace names and document titles; internal identifiers are optional.

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": {
      "context": "<context>"
    },
    "name": "read_article"
  }
}

Input Schema

Name	Required	Description
`context`	Yes	Describe the user's underlying goal in one sentence. Do not include private document content, credentials, or personal information.
`articleId`	No	Internal document identifier when already available. Omit it when the user referred to the document by title.
`workspaceId`	No	Optional workspace ID to narrow document lookup. Omit when the document title or ID uniquely identifies a document across authorized workspaces.
`articleTitle`	No	Human-visible document title. Prefer this over asking the user for an internal document identifier.
`workspaceName`	No	Optional workspace name to narrow document lookup. A unique document title can be used without a workspace choice.

Output Schema

Name	Required	Description	Default
`title`	No
`content`	Yes
`folderId`	No
`isPinned`	No
`articleId`	Yes
`createdAt`	No
`editorUrl`	No
`updatedAt`	No
`isArchived`	No
`contentHash`	Yes
`workspaceId`	Yes
`collaborative`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed5 schema fields changedOct 10, 2026

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"
+]
```

First observedAug 28, 2026

TDQS

A3.6/5.0

Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and non-destructive, so the safety profile is covered. The description adds that the content returned is the currently saved revision (not a rendered or draft view), which is genuinely useful context, but it says nothing about authorization scope or lookup failure behavior when a title is ambiguous.

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 short sentences with no filler; the core action is front-loaded and the identifier guidance follows. Every clause carries information the agent can act on.

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?

An output schema exists, so return values need not be described, and the annotation set covers the safety profile. The remaining gap is minor: nothing explains how lookups resolve when a title matches multiple documents, which the schema hints at but does not settle.

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 description coverage is 100%, so every parameter is already documented, including the preference for articleTitle over articleId and the optional narrowing role of workspaceId/workspaceName. The description restates that preference in prose but adds no syntax, format, or ambiguity-resolution detail beyond the schema, so 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?

States a specific verb and resource ('Read the current saved Markdown content and metadata for a document'), and the word 'saved' implicitly separates it from render_article, which produces a rendered view. It does not name any sibling explicitly, so the differentiation is inferable 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?

The second sentence gives real invocation guidance on how to identify the document (natural workspace names and titles preferred, internal identifiers optional), which is implied usage rather than explicit when-to-use. It never says when to choose this over list_articles or render_article, so the routing guidance is only partial.

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

All Markdown by mdedit.ai tools Inspect

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

Need Help?