Skip to content

docs: document the integration contract and trust model#51

Open
AbhiramDwivedi wants to merge 2 commits into
NVIDIA:mainfrom
AbhiramDwivedi:pr/a2-integration-contract
Open

docs: document the integration contract and trust model#51
AbhiramDwivedi wants to merge 2 commits into
NVIDIA:mainfrom
AbhiramDwivedi:pr/a2-integration-contract

Conversation

@AbhiramDwivedi

@AbhiramDwivedi AbhiramDwivedi commented Jun 14, 2026

Copy link
Copy Markdown

Closes #56

What

Documentation only. Adds two README sections so other tools can integrate against SkillSpector reliably:

  • Integrating SkillSpector — exit codes, the JSON output shape, the severity/recommendation enums + band mapping, and a recommended install-gate mapping (SAFE→allow, CAUTION→ask, DO_NOT_INSTALL→block).
  • Trust model and data egress — no execution of scanned code; LLM analysis sends file contents unless --no-llm; SC4 sends dependency names to OSV.dev by design; defense-in-depth, not a sandbox.

Cross-linked from docs/DEVELOPMENT.md.

Stacked on #50 — please review/merge that first. This PR will then show only its own delta.

Test

No code changes.

🤖 Generated with Claude Code

AbhiramDwivedi and others added 2 commits June 14, 2026 08:49
The MCP, semantic, and taint-tracking analyzers are implemented, but DEVELOPMENT.md still described them as stubs. Update the package-layout and "Stub analyzers" sections to reflect actual status (only mcp_rug_pull remains a stub), fix an invalid `//` comment in the Python example, and replace dangling internal "SADD" references in graph.py with neutral roadmap notes. Also refresh two stale "stub" docstrings. Docs and comments only; no behavior change.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Ram Dwivedi <abhiram.dwivedi@yahoo.com>
Add an "Integrating SkillSpector" section (exit codes, JSON shape, severity/recommendation enums, and a recommended install-gate mapping) and a "Trust model and data egress" section (no skill execution; LLM sends file contents unless --no-llm; SC4 sends dependency names to OSV.dev by design). Cross-link from DEVELOPMENT.md. Documentation only; no behavior change.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Ram Dwivedi <abhiram.dwivedi@yahoo.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: document the machine-readable integration contract and trust model

1 participant