Skip to main content
Glama
Sign In
docs-publisher

docs-publisher

by ArfZkwn-coder
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Hybrid

read_tutorial

Retrieve the current Markdown source of a documentation tutorial by its docs-relative path so you can inspect or edit the content.

Instructions

Read the current Markdown source of a tutorial.

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": {
      "path": "<path>"
    },
    "name": "read_tutorial"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesTutorial path relative to the docs folder, e.g. 'getting-started/install'

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.2/5.0
Behavior3/5

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

With no annotations, the description carries the burden, and it does disclose the return content (Markdown source) and that it reflects the 'current' state. It stops short of confirming non-mutation, permission requirements, or what happens when the path does not exist.

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?

A single front-loaded sentence with no filler; every word earns its place. It is minimal, but appropriately so for a one-parameter read.

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?

For a simple read with one fully documented parameter and no output schema, the description covers what is returned, but omits error behavior (missing path) and whether drafts/published content differ. Adequate but with clear gaps.

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% and the path parameter is fully documented with an example ('getting-started/install'), so the description adds nothing further about parameters. 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 (read) and resource (tutorial) plus what exactly is returned: the Markdown source. It is distinguishable from edit_tutorial/delete_tutorial/publish_tutorial by the read verb, though it does not explicitly contrast with list_tutorials (single item vs. enumeration).

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

Usage Guidelines2/5

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

No guidance on when to use this versus list_tutorials or edit_tutorial, and no prerequisites stated. The agent must infer from the tool name alone that this is the single-item fetch.

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

Deploy Server

Other Tools