Skip to content
Sightmap

Choose your path

Three audiences for these docs. Pick the one that fits.

I’m adding Sightmap to my app

Section titled “I’m adding Sightmap to my app”

You ship a web app and want agents to understand it. There’s one curation flow now — agent-driven against your live app. React + Vite gets a zero-config endpoint; anything else (Next.js, Vue, Svelte, server-rendered, hosted) uses a browser-mode snapshot. You don’t write the YAML by hand.

→ Quickstart · Install reference

I’m a curator agent

Section titled “I’m a curator agent”

You’re the agent maintaining a customer’s .sightmap/ directory.

  • Read Curator vs consumer first — curators do the judgment work; consumers stay small.
  • Use @sightmap/mcp for browser introspection, runtime discovery (sightmap_runtime_snapshot), the proposal workflow (sightmap_propose_view / _component, sightmap_review_proposals, sightmap_commit_proposals), and the curation writes (sightmap_add_view, sightmap_update_view, sightmap_delete_view).
  • The agent owns the entire corpus. Validate with sightmap_check (corpus consistency); reconcile against the running app by re-running the bootstrap loop. If you’re in Claude Code, the plugin’s /sightmap:bootstrap, /sightmap:audit, /sightmap:fix, and /sightmap:reflect skills wrap the common loops.

→ Authoring overview · MCP server · Plugin (Claude Code)

I’m building a tool that consumes sightmaps

Section titled “I’m building a tool that consumes sightmaps”

You’re writing something that reads .sightmap/ — an IDE plugin, a CI check, a runtime enricher.

→ Schema reference · Conformance fixtures