Skip to content
Sightmap

Choose your path

Three paths through the docs. Pick one.

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.

  • React (React Router 7): install @sightmap/react, mark components with data-sightmap, run sightmap-react gen to scaffold YAML.
  • Anything else: install the MCP server or the Claude Code plugin and let an agent bootstrap .sightmap/ for you.
  • You don’t write the YAML by hand. Codegen owns structure (names, routes, selectors); agents own the semantic fields (memory, intent, request annotations).

→ Quickstart (React) · Quickstart (agent-authored)

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 — the two roles have different toolsets and different rules.
  • Use @sightmap/mcp for browser introspection and the curation tools (sightmap_list_views, sightmap_get_view, sightmap_update_view, sightmap_check).
  • Component, route, and selector edits are codegen-owned, not MCP-owned. To add a component, write data-sightmap into source and re-run sightmap-react gen.

→ Authoring overview · MCP server

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