Orrery.
← All Stars

public Star · 0.1.0

orrery/structure-audit

Pure markdown structure audit with coded findings.

Use this when

  • You need heading gap / frontmatter / orphan findings on a markdown set
  • You want a pure sealed audit with no egress

Not for

  • MyST inventory analyze-stage digests (use docs-myst-inventory)
  • Fetching docs from the network
  • Rewriting or fixing documents

Inputs / Outputs

Inputs

NameTypeNotes
files required array [{path, content}] markdown only

Outputs

NameTypeNotes
findings array
finding_codes array
passed boolean
envelope signed-envelope

Example

{
  "method": "tools/call",
  "params": {
    "name": "audit",
    "arguments": {
      "files": []
    }
  }
}

Tools

audit Audit a markdown file set for heading gaps, frontmatter errors, and orphans · schema
{
  "type": "object",
  "properties": {
    "files": {
      "type": "array",
      "minItems": 1,
      "maxItems": 500,
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "minLength": 1,
            "maxLength": 512
          },
          "content": {
            "type": "string"
          }
        },
        "required": [
          "path",
          "content"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "files"
  ],
  "additionalProperties": false
}

In constellations