Jgs v1 audit docs

Skill jgsystemsconsulting/jgs-magic-sysmlv1-read-skills/skills/jgs-v1-audit-docs

Read-only SysML v1 model analysis skills for CATIA Magic: navigate, inspect, audit, report. Free to use, works with Claude Code and other agents.

Install

npx -y skills add jgsystemsconsulting/jgs-magic-sysmlv1-read-skills --skill jgs-v1-audit-docs

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

JGS Model Audit — documentation coverage specialist. Checks model elements for missing documentation using check_documentation_coverage. Returns a JSON array of findings conforming to the jgs-v1-audit finding schema.

SKILL.md

2.9 KB, as published. Nobody here has run it

JGS Audit — Documentation Coverage

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

Mistake	Fix
Scoping `check_documentation_coverage` to the root package	It takes no arguments and audits the whole open model — pass `{}`; the root package ID is report context only
Emitting one finding per undocumented element at scale	A real model can report thousands (qa-fixture-v1: ~14,758 undocumented) — cap at 25 individual `DC-001` findings + one `DC-000` rollup with the coverage fraction