Use Engineering Docs MCP server for document validation

{
  "mcpServers": {
    "engineering-docs": {
      "command": "node",
      "args": ["scripts/validate.js"],
      "description": "Engineering Docs validation server - provides tools for validating document completeness, checking cross-references, and generating indexes."
    }
  }
}

title:          # Document title
skill:          # Source skill name (e.g., system-architecture-document)
status:         # draft | final | superseded
owner_reviewed: # true | false
last_updated:   # date (YYYY-MM-DD)
depends_on:     # [list of filenames this document depends on]

{
  "ok": false,
  "required": [
    { "slug": "business-plan", "file": "1-business-plan.md", "status": "final", "issues": [] },
    { "slug": "deployment-plan", "status": "missing" }
  ],
  "conditional": [
    { "slug": "security-threat-model", "file": "11-security-threat-model.md", "status": "draft", "issues": [] }
  ],
  "errors": ["Required document missing: deployment-plan"]
}

{
  "ok": true,
  "files_checked": 12,
  "issues": [
    {
      "type": "terminology_inconsistency",
      "detail": "Multiple forms found: PostgreSQL, Postgres — consider standardizing"
    },
    {
      "type": "entity_gap",
      "file": "9-api-design.md",
      "detail": "5 entities from 8-database-design.md not referenced (may be intentional): Payment Method, Subscription Plan..."
    }
  ]
}

# Master Project Index

Generated: 2025-01-15

## Document Set

| # | Document | Status | Reviewed | Last Updated |
|:--|:---------|:-------|:---------|:-------------|
| 1 | [Business Plan](1-business-plan.md) | final | true | 2025-01-10 |
| 2 | [Project Plan](2-project-plan.md) | final | true | 2025-01-10 |
| ... | ... | ... | ... | ... |

## Reading Order

Documents should be read in the order listed above, as each builds on prior context.

## Status Summary

- **Final:** 10
- **Draft:** 2
- **Total:** 12

{
  "ok": true,
  "index": "# Master Project Index\n\nGenerated: 2025-01-15\n...",
  "stats": {
    "total": 12,
    "draft": 2,
    "final": 10
  }
}

{
  "hooks": {
    "SessionStart": [
      {
        "matcher": "startup|clear|compact",
        "hooks": [
          {
            "type": "command",
            "command": "node hooks/check-progress.js",
            "async": false
          }
        ]
      }
    ]
  }
}

[engineering-docs] Documentation in progress for this project:
  - 12 document(s) in the index
  - 2 item(s) still in draft or in-progress status:
    > 11-security-threat-model.md draft false 2025-01-14
    > 14-implementation-plan.md in-progress false 2025-01-14

  To continue, invoke the engineering-docs orchestrator — it will
  read the existing index and resume from where you left off.

name: Documentation Quality Gate

on:
  pull_request:
    paths:
      - '.engineering-docs/**'

jobs:
  validate-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '20'

      - name: Validate document set
        run: |
          echo '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"validate_document_set","arguments":{}}}' \
            | node scripts/validate.js \
            | node -e "
                const chunks = [];
                process.stdin.on('data', c => chunks.push(c));
                process.stdin.on('end', () => {
                  const res = JSON.parse(chunks.join(''));
                  const result = JSON.parse(res.result.content[0].text);
                  if (!result.ok) {
                    console.error('Document validation failed:', result.errors);
                    process.exit(1);
                  }
                  console.log('All required documents present and valid.');
                });
              "

      - name: Check cross-document consistency
        run: |
          echo '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"check_consistency","arguments":{}}}' \
            | node scripts/validate.js \
            | node -e "
                const chunks = [];
                process.stdin.on('data', c => chunks.push(c));
                process.stdin.on('end', () => {
                  const res = JSON.parse(chunks.join(''));
                  const result = JSON.parse(res.result.content[0].text);
                  const errors = (result.issues || []).filter(i => i.type !== 'entity_gap');
                  if (errors.length > 0) {
                    console.error('Consistency issues found:', errors);
                    process.exit(1);
                  }
                  console.log('Consistency check passed. Files checked:', result.files_checked);
                });
              "