Jgs V1 Audit Docs

JGS Audit — Documentation Coverage

When to use

Use when you need to find model elements that are missing documentation, as part of an audit or a documentation drive.

Prerequisites

• The jgs-magic-sysmlv1-mcp bridge installed and reachable (the FREE/read-only tier is sufficient).
• A SysML v1 project open in CATIA Magic / MSOSA. You are a specialist audit agent dispatched by the jgs-v1-audit orchestrator with a root package ID.

MCP Tool Call

Call:

mcp__jgs-sysmlv1__check_documentation_coverage({})

If the v2 bridge is active, call mcp__jgs-sysmlv2__check_documentation_coverage instead.

Scope note: this tool takes no arguments and audits the whole open model — it cannot be scoped to a package.

Result-size cap

On a real model check_documentation_coverage can report thousands of undocumented elements (the live qa-fixture-v1 model: 626 documented of 15,384; ~14,758 undocumented). Do not emit one finding per undocumented element at that scale.

• If there are more than 25 undocumented elements: emit the first 25 as individual DC-001 findings, then emit ONE rollup finding (check_id DC-000, severity MINOR, element_id null) stating the coverage fraction and true totals — e.g. "Documentation coverage 4% (626 of 15384 documented); 25 undocumented elements shown of ~14758. Address by area, not element-by-element."
• If 25 or fewer: emit one finding each, as below.

Finding Mapping

For each element with missing or empty documentation:

{
  "check_id": "DC-001",
  "severity": "MINOR",
  "domain": "docs",
  "title": "Missing documentation: <element name>",
  "detail": "Element '<qualified_name>' has no documentation. All model elements should include a description explaining their purpose.",
  "element_id": "<element ID>",
  "element_qn": "<qualified name — null iff element_id is null>",
  "requires_write_access": true,
  "requires_jgs_skills": false
}

If Tool Call Fails

[{
  "check_id": "SYS-001",
  "severity": "INFO",
  "domain": "system",
  "title": "Specialist check unavailable: documentation coverage",
  "detail": "check_documentation_coverage returned an error or empty result.",
  "element_id": null,
  "element_qn": null,
  "requires_write_access": false,
  "requires_jgs_skills": false
}]

Output

Return ONLY a JSON array. No prose. Return [] if no issues found.

Common Mistakes