Skip to main content
Glama
mockzilla

Mockzilla

Official
by mockzilla
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Hybrid

mockzilla_docs_read

Read Mockzilla documentation by topic or category, returning full markdown and public page URLs for the requested content.

Instructions

Return the full markdown of Mockzilla doc topics. Pass topics with one or more ids from mockzilla_docs_topics, or category to read a whole category in one call. A large request returns what fits and lists the rest in remaining: read those in a second call. A link to another topic reads as (topic id). Each topic carries url, its public page, to give the user; don't fetch it, the markdown is the same page.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicsNoTopic ids from `mockzilla_docs_topics`, e.g. ['getting-started/terminology', 'engine/contexts'].
categoryNoA category slug from `mockzilla_docs_topics`, e.g. 'simulations'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.2.20
    • addedInput schema / properties / category
      Added value: +{
+  "description": "A category slug from `mockzilla_docs_topics`, e.g. 'simulations'.",
+  "type": "string"
+}
    • removedInput schema / properties / topic
      Removed value: -{
-  "description": "Topic name from `mockzilla_docs_topics` (e.g. 'middleware', 'usage/portable').",
-  "type": "string"
-}
    • addedInput schema / properties / topics
      Added value: +{
+  "description": "Topic ids from `mockzilla_docs_topics`, e.g. ['getting-started/terminology', 'engine/contexts'].",
+  "items": {
+    "type": "string"
+  },
+  "minItems": 1,
+  "type": "array"
+}
    • removedInput schema / required
      Removed value: -[
-  "topic"
-]
  2. First observedv0.1.0

TDQS

A4.7/5.0
Behavior5/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It reveals truncation behavior with `remaining`, explains how inter-topic links render as `(topic id)`, and clarifies that each topic includes a public `url` that should be given to the user but not fetched. This is detailed and useful.

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?

Four sentences, all substantive and front-loaded with the core purpose. Every clause adds operational detail—truncation, link handling, and URL usage—without repetition or filler.

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

Completeness5/5

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

For a two-parameter read tool with no output schema and no annotations, the description is exceptionally complete. It covers input selection, response truncation and pagination, link representation, and user-facing URL behavior. An agent has what it needs to call the tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema already documents both parameters, so the baseline is 3. The description adds meaningful semantics: `category` reads a whole category in one call, `topics` accepts one or more ids, and large responses may require follow-up reads via `remaining`. This goes beyond the schema's basic type hints.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Return'), the object ('full markdown'), and the scope ('Mockzilla doc topics'). It is distinct from siblings like mockzilla_docs_topics and mockzilla_docs_search, making it easy for an agent to know this tool reads full doc content.

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

Usage Guidelines4/5

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

The description gives concrete direction on when to use `topics` vs `category`, and explicitly tells the agent not to fetch the `url` because the markdown is the same page. It references mockzilla_docs_topics for id sourcing, though it does not explicitly contrast this tool with mockzilla_docs_search.

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