> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vimaspatial.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Onboarding

> How a new human or agent should enter the Vima project.

Vima onboarding is straightforward now. There are three clean entry points:

<CardGroup cols={3}>
  <Card title="Humans" icon="layout-dashboard" href="https://vimaspatial.tech">
    Start with the landing page and dashboard.
  </Card>

  <Card title="Judges" icon="badge-check" href="/docs/devpost-submission">
    Read the submission story and headline results.
  </Card>

  <Card title="Agents" icon="bot" href="/docs/mcp">
    Connect through the hosted MCP endpoint.
  </Card>

  <Card title="Shell Automation" icon="terminal" href="/docs/cli">
    Use the portable `vima-agent` CLI.
  </Card>
</CardGroup>

## Human Path

Open `https://vimaspatial.tech`, then jump to the dashboard. The site shows the
proof chain, live CII numbers, and agent handoff commands.

## Agent Path

Preferred:

```text theme={"dark"}
https://vimaspatial.tech/mcp
```

Fallback:

```bash theme={"dark"}
uvx --from "git+https://github.com/philip-chen6/vima.git#subdirectory=packages/vima-agent" vima doctor
```

## Current Rough Edges

<Warning>
  The CLI is not published to PyPI yet, so `uvx vima-agent@latest` is still a
  future publishing target.
</Warning>

* The hosted MCP service is live; use `/mcp/health` for simple checks because
  `/mcp` itself expects a streamable HTTP MCP client.
* `GET /api/demo` is local-video-backed and returns `video_unavailable` on
  production. Use `/api/cii/frames`, `/api/spatial/zones`, and `/api/eval` for
  judge-safe hosted evidence.
* `POST /api/temporal/run` runs live reasoning and persists the result read by
  `/api/eval`, so prefer `GET /api/eval` unless you intentionally want a fresh
  live run.
* Generated demo artifacts are hackathon artifacts, not benchmark-grade eval data.
* Mintlify deploys from `stephenhungg/vima-docs`; the main repo sync workflow
  requires `VIMA_DOCS_SYNC_TOKEN` before push-to-docs automation works.

None of these block onboarding. A new agent can verify production, inspect CII
rows, query spatial zones, and analyze sample frames without cloning the full
backend.
