API Contract Auditor (L3)

VerifiedSafe

Audits API contracts, method signatures, layer leakage, and error contract consistency.

Sby Skills Guide Bot
DevelopmentAdvanced
7/23/2026
Claude Code
#api-contracts#architecture-audit#dto#layer-boundaries#code-review

Recommended for

Automated summary

This L3 worker audits API contracts at service boundaries — layer leakage, missing DTOs, entity exposure and inconsistent error contracts — returning a structured scored report.

Strengths

  • Six explicit detection rules (layer leakage, missing DTO, entity leakage, error contracts, redundant overloads, architectural honesty) with graded severity levels
  • Two-layer detection: Grep candidate scan followed by context verification to reduce false positives
  • Automatically discovers API/service/domain boundaries and maps which endpoints call which services
  • Supports global and domain-aware modes, and explicitly reports fallback to Read/Grep/Glob when the hex-graph/hex-line MCP tools are unavailable

Limitations

  • Covers architecture boundaries only — code duplication is explicitly out of scope
  • Relies on external reference files (detection_patterns.md, two_layer_detection.md) living in the skill's own repository
  • Detection patterns in the references are language-specific, which can leave blind spots on other stacks
  • Produces analysis and scores rather than applying fixes
When to use it

Use it during an architecture review to verify that an API layer respects its boundaries and does not expose internal entities.

When not to use it

Avoid it if you need code-duplication findings or automatic remediation of the issues it detects.

Security analysis

Safe
Quality score78/100

The skill is a read-only static-analysis auditor for API contract boundaries. It enumerates Glob/Grep/symbol-lookup steps and writes a JSON/markdown report to a run-scoped artifact directory. Bash is permitted but never tied to a destructive or outbound operation, and there is no instruction to run downloaded code, touch secrets, or bypass guardrails. Risk is limited to ordinary codebase reading.

Findings
  • •Bash is in allowed-tools but the workflow only describes read-only discovery (Glob/Grep/Read) and report writing; no destructive commands specified
  • •No network calls, credential access, or exfiltration behavior
  • •No obfuscation, encoded payloads, or instructions to disable safety checks
  • •Reads reference files from the skill's own references/ directory — expected and benign
How this analysis is made

Examples

Audit API layer boundaries
Audit the API contracts in src/api and src/services: check for layer leakage, missing DTOs, and ORM entities returned without a response DTO. Report findings with severity levels.
Domain-scoped contract check
Run the API contract auditor in domain-aware mode on src/users/ and flag any inconsistent error contracts (mixing raise and return None) in the user services.
Check entity leakage before release
Before we ship, scan the controllers layer for ORM entities exposed directly in API responses and tell me which endpoints need a response DTO.

name: ln-643-api-contract-auditor description: "Checks layer leakage in method signatures, missing DTOs, entity leakage to API, inconsistent error contracts. Use when auditing API contracts." allowed-tools: Read, Grep, Glob, Bash, mcp__hex-graph__find_references, mcp__hex-graph__find_symbols, mcp__hex-line__read_file, mcp__hex-line__grep_search, mcp__hex-line__outline license: MIT

Paths: File paths (references/, ../ln-*) are relative to this skill directory.

API Contract Auditor (L3 Worker)

Type: L3 Worker

Specialized worker auditing API contracts, method signatures at service boundaries, and DTO usage patterns.

Purpose & Scope

  • Audit API contracts at architecture level (service boundaries, layer separation)
  • Check layer leakage, DTO patterns, error contract consistency
  • Return structured analysis with 4 scores (compliance, completeness, quality, implementation)

Out of Scope:

  • Code duplication (same DTO shape repeated, same mapping logic, same validation)
  • Report only ARCHITECTURE BOUNDARY findings (wrong layer, missing contract)

Inputs

- pattern: "API Contracts"     # Pattern name
- locations: string[]          # Service/API directories
- adr_reference: string        # Path to related ADR
- bestPractices: object        # Best practices from MCP Ref/Context7
- output_dir: string           # e.g., ".hex-skills/runtime-artifacts/runs/{run_id}/audit-report"

# Domain-aware (optional)
- domain_mode: "global" | "domain-aware"   # Default: "global"
- current_domain: string                   # e.g., "users", "billing" (only if domain-aware)
- scan_path: string                        # e.g., "src/users/" (only if domain-aware)

Workflow

Phase 0: Load References

Load references/detection_patterns.md -- language-specific Grep patterns for all 5 rules. Detection policy: use two-layer detection (candidate scan, then context verification); load references/two_layer_detection.md only when the verification method is ambiguous. Tool policy: follow host AGENTS.md MCP preferences; load references/mcp_tool_preferences.md and references/mcp_integration_patterns.md only when host policy is absent or MCP behavior is unclear.

Use hex-graph first when symbol or reference analysis materially improves contract findings. Use hex-line first for local code reads when available. If MCP is unavailable, unsupported, or not indexed, continue with built-in Read/Grep/Glob/Bash and state the fallback in the report.

Phase 1: Discover Service Boundaries

scan_root = scan_path IF domain_mode == "domain-aware" ELSE codebase_root

1. Find API layer: Glob("**/api/**/*.py", "**/routes/**/*.ts", "**/controllers/**/*.ts", root=scan_root)
2. Find service layer: Glob("**/services/**/*.py", "**/services/**/*.ts", root=scan_root)
3. Find domain layer: Glob("**/domain/**/*.py", "**/models/**/*.py", root=scan_root)
4. Map: which services are called by which API endpoints

Phase 2: Analyze Contracts (5 Rules)

MANDATORY READ: Load references/detection_patterns.md for language-specific Grep patterns per rule.

| # | Rule | Severity | What to Check | |---|------|----------|---------------| | 1 | Layer Leakage | HIGH/MEDIUM | Service/domain accepts HTTP types (Request, parsed_body, headers) | | 2 | Missing DTO | MEDIUM/LOW | 4+ params repeated in 2+ methods without grouping DTO | | 3 | Entity Leakage | HIGH/MEDIUM | ORM entity returned from API without response DTO. Downgrade when: internal API with no external consumers -> LOW | | 4 | Error Contracts | MEDIUM/LOW | Mixed error patterns (raise + return None) in same service | | 5 | Redundant Overloads | LOW/MEDIUM | Method pairs with _with_/_and_ suffix differing by 1-2 params | | 6 | Architectural Honesty | HIGH/MEDIUM | Read-named function (get_/find_/check_/validate_/is_/has_) body contains write side-effects. Exclusions per references/ai_ready_architecture.md |

Scope boundary: SKIP duplication findings. REPORT only ARCHITECTURE BOUNDARY findings.

Phase 3: Calculate 4 Scores

Compliance Score (0-100):

| Criterion | Points | |-----------|--------| | No layer leakage (HTTP types in service) | +35 | | Consistent error handling pattern | +25 | | Follows project naming conventions | +10 | | No hidden side-effects in read-named functions | +10 | | No entity leakage to API | +20 |

Completeness Score (0-100):

| Criterion | Points | |-----------|--------| | All service methods have typed params | +30 | | All service methods have typed returns | +30 | | DTOs defined for complex data | +20 | | Error types documented/typed | +20 |

Quality Score (0-100):

| Criterion | Points | |-----------|--------| | No boolean flag params in service methods | +15 | | No opaque return types hiding write actions | +10 | | No methods with >5 params without DTO | +25 | | Consistent naming across module | +25 | | No redundant overloads | +25 |

Implementation Score (0-100):

| Criterion | Points | |-----------|--------| | DTOs/schemas exist and are used | +30 | | Type annotations present | +25 | | Validation at boundaries (Pydantic, Zod) | +25 | | API response DTOs separate from domain | +20 |

Phase 3.5: Calculate Score

MANDATORY READ: Load references/audit_worker_core_contract.md and references/audit_scoring.md.

Primary score uses penalty formula (same as all workers):

penalty = (critical x 2.0) + (high x 1.0) + (medium x 0.5) + (low x 0.2)
score = max(0, 10 - penalty)

Diagnostic sub-scores (0-100 each) are calculated separately and reported in AUDIT-META for diagnostic purposes only.

Phase 4: Write Report

MANDATORY READ: Load references/templates/audit_worker_report_template.md.

Write JSON summary per references/audit_summary_contract.md. In managed mode the caller passes both runId and summaryArtifactPath; in standalone mode the worker generates its own run-scoped artifact path per shared contract.

# Build markdown report in memory with:
# - AUDIT-META (extended: score [penalty-based] + diagnostic score_compliance/completeness/quality/implementation)
# - Checks table (layer_leakage, missing_dto, entity_leakage, error_contracts, redundant_overloads)
# - Findings table (issues sorted by severity)
# - DATA-EXTENDED: issues array with principle + domain fields (for cross-domain aggregation)

IF domain_mode == "domain-aware":
  Write to {output_dir}/643-api-contract-{current_domain}.md
ELSE:
  Write to {output_dir}/643-api-contract.md

Phase 5: Return Summary

Report written: .hex-skills/runtime-artifacts/runs/{run_id}/audit-report/643-api-contract-users.md
Score: 6.75/10 (C:65 K:70 Q:55 I:80) | Issues: 4 (H:2 M:1 L:1)

Critical Rules

Apply the already-loaded references/audit_worker_core_contract.md.

  • Architecture-level only: Focus on service boundaries, not internal implementation
  • Read before score: Never score without reading actual service code
  • Scope boundary: SKIP duplication findings
  • Detection patterns: Use language-specific Grep from detection_patterns.md
  • Domain-aware: When domain_mode="domain-aware", scan only scan_path, tag findings with domain
  • Unique angle: Audit service/API boundary contracts only. Do not audit code duplication, package health, dependency topology, or runtime operations.
  • Action required: Every finding uses ADD_DTO, STOP_ENTITY_LEAK, or STANDARDIZE_ERROR_CONTRACT.

Definition of Done

Apply the already-loaded references/audit_worker_core_contract.md.

  • [ ] Service boundaries discovered (API, service, domain layers)
  • [ ] Method signatures extracted and analyzed
  • [ ] All 5 rules checked using detection_patterns.md
  • [ ] Scope boundary applied (no duplication findings)
  • [ ] 4 scores calculated with justification
  • [ ] Issues identified with severity, location, suggestion, effort
  • [ ] If domain-aware: findings tagged with domain field
  • [ ] Report written to {output_dir}/643-api-contract[-{domain}].md (atomic single Write call)
  • [ ] Summary written per contract

Reference Files

  • Detection patterns: references/detection_patterns.md
  • Scoring rules: references/audit_scoring.md

Version: 2.0.0 Last Updated: 2026-02-08

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/api-contract-auditor-l3-mrx3xxt5/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/api-contract-auditor-l3-mrx3xxt5' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/api-contract-auditor-l3-mrx3xxt5/download' --output '.skill-downloads/api-contract-auditor-l3-mrx3xxt5/SKILL.md.part' && mv '.skill-downloads/api-contract-auditor-l3-mrx3xxt5/SKILL.md.part' '.skill-downloads/api-contract-auditor-l3-mrx3xxt5/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

Tools declared by the author (check availability in your agent): Read, Grep, Glob, Bash, mcp__hex-graph__find_references, mcp__hex-graph__find_symbols, mcp__hex-line__read_file, mcp__hex-line__grep_search, mcp__hex-line__outline

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/api-contract-auditor-l3-mrx3xxt5/SKILL.md' && test -s '.skill-downloads/api-contract-auditor-l3-mrx3xxt5/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/ln-643-api-contract-auditor' && cp -R '.skill-downloads/api-contract-auditor-l3-mrx3xxt5' '.claude/skills/ln-643-api-contract-auditor'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/api-contract-auditor-l3-mrx3xxt5'

openskills read 'api-contract-auditor-l3-mrx3xxt5'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/api-contract-auditor-l3-mrx3xxt5/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills