Audit Documentation Coverage
audit_documentation_coverageAudit documentation coverage by scanning workspace nodes and columns, returning counts, percentages, and lists of undocumented items to identify gaps.
Instructions
Scan all nodes and columns in a workspace and report documentation coverage statistics.
Args: workspaceID: Workspace to audit
Returns: Total and documented counts for nodes and columns, percentage coverage, and lists of undocumented nodes and columns (column list capped at 200). A node is 'documented' if it has a non-empty description. A column is 'documented' if its metadata.columns[] entry has a non-empty description field.
Requires a lineage cache — will fetch all workspace nodes with detail=true on first call (may take a moment for large workspaces). Subsequent calls use the cached graph (default TTL: 30 min).
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": {
"workspaceID": "<workspaceID>"
},
"name": "audit_documentation_coverage"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workspaceID | Yes | Workspace ID to audit |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| auditedAt | No | ||
| totalNodes | No | ||
| workspaceID | No | ||
| totalColumns | No | ||
| documentedNodes | No | ||
| truncatedColumns | No | ||
| documentedColumns | No | ||
| undocumentedNodes | No | ||
| undocumentedColumns | No | ||
| undocumentedNodeList | No | ||
| undocumentedColumnList | No | ||
| nodeDocumentationPercent | No | ||
| columnDocumentationPercent | No |