Skip to content

Add Context7 documentation for @ottersight/scanner and @ottersight/cli #8

@pikespeak

Description

@pikespeak

Problem

Context7 is an MCP server that provides up-to-date library documentation to AI assistants (Claude, Cursor, Copilot). When developers ask their AI assistant about OtterSight, Context7 has no documentation to serve — the AI falls back on (potentially stale) training data.

Expected behavior

AI assistants using Context7 can fetch current OtterSight documentation:

User: "How do I use @ottersight/scanner to scan a project?"
AI: [fetches docs from Context7] → accurate, up-to-date API reference

Scope

  • Register @ottersight/scanner and @ottersight/cli in Context7's library index
  • Provide structured documentation covering:
    • scanLocal() API (parameters, return types, examples)
    • loadKev(), loadEuvdMapping(), lookupLatestVersions() APIs
    • CLI usage (ottersight scan ., flags, exit codes)
    • Docker usage
    • Prerequisites (Syft, Grype)

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions