docs-publisher

publish_tutorial

Create a new tutorial or fully replace an existing one in a Git-based docs site; front matter is added automatically when missing.

Instructions

Create a new tutorial or fully replace an existing one. Front matter (title, description, sidebar_position) is added automatically if the content has none.

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": {
      "title": "<title>",
      "content": "<content>"
    },
    "name": "publish_tutorial"
  }
}

Input Schema

Name	Required	Description
`path`	No	Path relative to the docs folder, e.g. 'guides/install'. Defaults to a slug of the title.
`title`	Yes	Tutorial title
`content`	Yes	Full Markdown body of the tutorial
`description`	No	Short summary used in front matter
`commit_message`	No
`sidebar_position`	No	Order in the sidebar

Schema Changelog

Changes observed during successful MCP inspections.

First observedv1.0.0Oct 31, 2026

TDQS

A3.5/5.0

Behavior3/5

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

With no annotations, the description carries the full burden. It usefully discloses one behavior beyond the schema — that front matter is auto-injected when absent — but omits that the 'replace' mode is destructive to existing content, whether overwrites are reversible, and any permission or conflict behavior.

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, no filler, with the create-vs-replace scope stated first and the automatic front-matter note second. Every sentence earns its place.

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 6-parameter mutation tool with no annotations and no output schema, the description covers the core create/replace contract and front matter but leaves out conflict behavior on existing paths, what is returned, and whether a follow-up deploy_site is needed.

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 already documents title, content, description, path and sidebar_position. The description adds only the front-matter defaulting rule; it says nothing about commit_message, the one parameter with no schema description.

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 (create/replace) and resource (tutorial) with a scope note: 'fully replace'. This implicitly contrasts with edit_tutorial (partial edits) but never names the sibling, so differentiation is inferable rather than explicit.

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?

Says the tool creates new or fully replaces existing content, which hints at when it applies, but there is no explicit 'use this instead of edit_tutorial when...' guidance nor any mention of prerequisites such as deploy_site afterward.

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

Deploy Server