Scopewalker MCP

Overview Schema Source Related Servers Discussions Admin

Documentation Coverage

get_documentation_coverage

Read-onlyIdempotent

Scan files or directories to find undocumented functions and classes, so you can measure documentation coverage and target gaps.

Instructions

Finds undocumented functions/classes. Use limit/summary_only to control output.

Input Schema

TableJSON Schema

Name	Required	Description
`path`	Yes	File or directory to analyze; must be inside the allowed roots
`limit`	No	Max undocumented items returned (default 20)
`max_depth`	No	Max directory depth to descend (default unlimited)
`max_files`	No	Stop after scanning this many files (default unlimited)
`min_lines`	No	Ignore functions shorter than this many lines (default 1)
`extensions`	No	Only scan these extensions, e.g. [".ts", ".py"] (default all supported)
`summary_only`	No	Return summary totals without per-item details (default false)
`include_hidden`	No	Include dotfiles and dot-directories (default false)
`ignore_patterns`	No	Extra gitignore-style patterns to exclude, relative to path

Output Schema

TableJSON Schema

Name	Required	Description	Default
`path`	Yes
`_meta`	No
`by_file`	Yes
`summary`	Yes
`coverage`	Yes
`truncated`	No
`undocumented_items`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed11 schema fields changedv1.4.0Oct 15, 2026

removedInput schema / additionalProperties
```
Removed value: -false
```

changedInput schema / properties / extensions / description

Previous value: -"Filter by extensions"New value: +"Only scan these extensions, e.g. [\".ts\", \".py\"] (default all supported)"

changedInput schema / properties / ignore_patterns / description

Previous value: -"Exclude patterns"New value: +"Extra gitignore-style patterns to exclude, relative to path"

changedInput schema / properties / include_hidden / description

Previous value: -"Include hidden"New value: +"Include dotfiles and dot-directories (default false)"

changedInput schema / properties / limit / description

Previous value: -"Max results"New value: +"Max undocumented items returned (default 20)"

changedInput schema / properties / max_depth / description

Previous value: -"Max depth"New value: +"Max directory depth to descend (default unlimited)"

changedInput schema / properties / max_files / description

Previous value: -"Max files to scan"New value: +"Stop after scanning this many files (default unlimited)"

changedInput schema / properties / min_lines / description

Previous value: -"Min function lines"New value: +"Ignore functions shorter than this many lines (default 1)"

changedInput schema / properties / path / description

Previous value: -"Target path"New value: +"File or directory to analyze; must be inside the allowed roots"

changedInput schema / properties / summary_only / description

Previous value: -"Summary only"New value: +"Return summary totals without per-item details (default false)"

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "additionalProperties": false,
+  "properties": {
+    "_meta": {
+      "additionalProperties": false,
+      "properties": {
+        "funding": {
+          "type": "string"
+        },
+        "item_count": {
+          "type": "number"
+        },
+        "response_size_chars": {
+          "type": "number"
+        },
+        "warning": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "item_count",
+        "response_size_chars",
+        "funding"
+      ],
+      "type": "object"
+    },
+    "by_file": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "documented": {
+            "type": "number"
+          },
+          "path": {
+            "type": "string"
+          },
+          "percentage": {
+            "type": "number"
+          },
+          "undocumented": {
+            "type": "number"
+          }
+        },
+        "required": [
+          "path",
+          "documented",
+          "undocumented",
+          "percentage"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "coverage": {
+      "additionalProperties": false,
+      "properties": {
+        "documented": {
+          "type": "number"
+        },
+        "percentage": {
+          "type": "number"
+        },
+        "undocumented": {
+          "type": "number"
+        }
+      },
+      "required": [
+        "documented",
+        "undocumented",
+        "percentage"
+      ],
+      "type": "object"
+    },
+    "path": {
+      "type": "string"
+    },
+    "summary": {
+      "additionalProperties": false,
+      "properties": {
+        "files_analyzed": {
+          "type": "number"
+        },
+        "files_skipped": {
+          "type": "number"
+        },
+        "fully_documented_files": {
+          "type": "number"
+        },
+        "scan_complete": {
+          "type": "boolean"
+        },
+        "total_symbols": {
+          "type": "number"
+        },
+        "zero_documentation_files": {
+          "type": "number"
+        }
+      },
+      "required": [
+        "files_analyzed",
+        "files_skipped",
+        "scan_complete",
+        "total_symbols",
+        "fully_documented_files",
+        "zero_documentation_files"
+      ],
+      "type": "object"
+    },
+    "truncated": {
+      "additionalProperties": false,
+      "properties": {
+        "items": {
+          "type": "number"
+        },
+        "total": {
+          "type": "number"
+        }
+      },
+      "required": [
+        "items",
+        "total"
+      ],
+      "type": "object"
+    },
+    "undocumented_items": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "line": {
+            "type": "number"
+          },
+          "lines": {
+            "type": "number"
+          },
+          "name": {
+            "type": "string"
+          },
+          "path": {
+            "type": "string"
+          },
+          "type": {
+            "enum": [
+              "function",
+              "class",
+              "method"
+            ],
+            "type": "string"
+          }
+        },
+        "required": [
+          "path",
+          "name",
+          "type",
+          "line"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    }
+  },
+  "required": [
+    "path",
+    "coverage",
+    "undocumented_items",
+    "by_file",
+    "summary"
+  ],
+  "type": "object"
+}

Changed9 schema fields changedv1.3.0Sep 15, 2026
- addedInput schema / properties / extensions / items / maxLength
```
Added value: +32
```
- addedInput schema / properties / extensions / items / pattern
```
Added value: +"^\\.?[A-Za-z0-9_+-]+$"
```
- addedInput schema / properties / extensions / maxItems
```
Added value: +100
```
- addedInput schema / properties / ignore_patterns / items / maxLength
```
Added value: +512
```
- addedInput schema / properties / ignore_patterns / maxItems
```
Added value: +100
```
- changedInput schema / properties / limit / maximum
```
Previous value: -9007199254740991New value: +5000
```
- changedInput schema / properties / max_depth / maximum
```
Previous value: -9007199254740991New value: +64
```
- changedInput schema / properties / max_files / maximum
```
Previous value: -9007199254740991New value: +10000
```
- changedInput schema / properties / min_lines / maximum
```
Previous value: -9007199254740991New value: +10000
```

Changed2 schema fields changedv1.0.5Aug 2, 2026

removedInput schema / properties / require_param_docs

Removed value: -{
-  "description": "Require param docs",
-  "type": "boolean"
-}

removedInput schema / properties / require_return_docs

Removed value: -{
-  "description": "Require return docs",
-  "type": "boolean"
-}

First observedv1.0.4Jul 31, 2026

TDQS

C2.9/5.0

Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description adds only a vague "control output" hint and never discloses that scanning is bounded by allowed roots or that unlimited max_files/max_depth defaults could be expensive. Beyond the annotations it contributes very little behavioral context.

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?

Two short sentences with the purpose front-loaded and no filler. It is efficiently sized, though the second sentence is arguably redundant with the schema and the terseness leaves gaps.

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?

An output schema exists, so return-value explanation is not required, and the 100% schema coverage plus annotations cover most mechanics. However, for a 9-parameter analysis tool with many siblings, the absence of any usage or scoping guidance leaves the description only minimally complete.

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 including limit and summary_only is already documented with types, defaults and bounds. The description's mention of limit/summary_only merely restates schema content and adds no syntax or format detail. Baseline 3 applies when the schema carries the full load.

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?

The description names a specific verb and resource: "Finds undocumented functions/classes." This clearly separates it from data-gathering siblings like get_functions or get_line_counts, though it does not explicitly name an alternative tool. The purpose is unambiguous without opening the schema.

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?

There is no when-to-use/when-not guidance and no mention of alternatives or prerequisites despite eight sibling tools. "Use limit/summary_only to control output" is parameter advice, not usage context, so an agent gets no help deciding when this tool beats get_code_smells or get_code_inventory.

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

Deploy Server