Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.riftmap.dev/llms.txt

Use this file to discover all available pages before exploring further.

The current API is sufficient for agent integration via raw HTTP — every flow on this site works today against https://riftmap.dev/api/v1 with a workspace API key. Two packaging layers are designed but deferred until there’s pull from real users. Building them before users ask risks designing for hypothetical workflows.

MCP server (riftmap-mcp)

Wraps the agent‑facing endpoints as MCP tools so Claude Code, Cursor, and Cline can use them without any HTTP plumbing in the agent’s prompt. Planned layout:
  • Published to PyPI as a separate package: pipx install riftmap-mcp.
  • Python implementation using Anthropic’s official mcp SDK.
Planned tool surface:
riftmap_lookup_repository       # → GET /repositories/lookup
riftmap_get_context             # → GET /repositories/{id}/context
riftmap_get_dependents          # → GET /repositories/{id}/dependents
riftmap_get_dependencies        # → GET /repositories/{id}/dependencies
riftmap_get_impact              # → GET /repositories/{id}/impact
riftmap_get_subgraph            # → GET /connected-orgs/{id}/graph
Auth: environment variables only.
RIFTMAP_API_KEY=rfm_live_xxx
RIFTMAP_BASE_URL=https://riftmap.dev/api/v1   # default

CLI (riftmap)

Same surface as a shell command for CI pipelines and humans who’d rather pipe JSON than write curl invocations. Planned commands:
riftmap lookup --url https://github.com/myorg/repo
riftmap context <repo_id>
riftmap dependents <repo_id> --limit 500
riftmap dependencies <repo_id>
riftmap impact <repo_id> --max-depth 3
riftmap subgraph <org_id> --root <repo_id> --depth 2
  • Ships as a riftmap console_script on PyPI, separate from internal operator tooling.
  • JSON output by default (agent‑friendly); --pretty flag for human reading.
  • Same env contract as the MCP server.

Order when building

CLI first — its auth and base‑URL plumbing is reused by the MCP server, which then becomes thin tool definitions over the CLI logic.

Why not now

The data and endpoints are the load‑bearing piece. Packaging is mechanical once the surface is stable. If you want either of these tomorrow and would actually use it, email hello@riftmap.dev — concrete demand is what unblocks the build.