Skip to main content
Glama
Sign In
diataxis-mcp-server

diataxis-mcp-server

by willermo
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Audit documentation tree

audit_doc_tree

Audit documentation pages to summarize mode distribution, confusion, and coverage with configurable scope for coverage warnings.

Instructions

Audit multiple documentation pages and summarize mode distribution, confusion, and coverage. Use scope=full-docs|section|sample to control how coverage warnings are interpreted.

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": {
      "pages": "<pages>"
    },
    "name": "audit_doc_tree"
  }
}

Input Schema

NameRequiredDescriptionDefault
pagesYes
scopeNofull-docs

Output Schema

NameRequiredDescriptionDefault
pagesYes
scopeYes
summaryYes
nextActionsYes
missingModesYes
dominantModesYes
coverageWarningsYes
suggestedNavigationYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / scope
      Added value: +{
+  "default": "full-docs",
+  "enum": [
+    "full-docs",
+    "section",
+    "sample"
+  ],
+  "type": "string"
+}
    • addedOutput schema / properties / scope
      Added value: +{
+  "enum": [
+    "full-docs",
+    "section",
+    "sample"
+  ],
+  "type": "string"
+}
    • changedOutput schema / required
      Previous value: -[
-  "pages",
-  "summary",
-  "missingModes",
-  "dominantModes",
-  "coverageWarnings",
-  "suggestedNavigation",
-  "nextActions"
-]New value: +[
+  "scope",
+  "pages",
+  "summary",
+  "missingModes",
+  "dominantModes",
+  "coverageWarnings",
+  "suggestedNavigation",
+  "nextActions"
+]
  2. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

No annotations are provided. The description mentions the summarization focus (mode distribution, confusion, coverage) and scope interpretation, but lacks details on error handling, authentication, or write behavior.

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?

The description is concise with two clear sentences. It could be structured slightly better but is efficient with no unnecessary words.

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

Completeness2/5

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

The description does not explain the output schema or return format, nor does it clarify coverage warnings or the purpose of page properties. Given the complexity of the nested parameter, this is a notable gap.

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

Parameters2/5

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

Schema description coverage is 0%. The description explains the 'scope' enum but does not detail the nested properties of 'pages' (path, title, content, declaredMode), leaving significant ambiguity.

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 tool audits multiple documentation pages and summarizes mode distribution, confusion, and coverage. It distinguishes from siblings like 'audit_doc_page' (single page) and other tools with different purposes.

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 description implies usage for auditing multiple pages and provides guidance on the 'scope' parameter, but does not explicitly compare to alternatives or state when not to use this tool.

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