Getting Started

Verify setup

Quick sanity checks.

1. Check the CLI

bash
larkx --version
# → larkx v0.1.0

2. Check the index

bash
larkx stats

Should print file counts, detected frameworks, and per-level token estimates.

3. Check the MCP server

bash
larkx mcp --check
# → ✓ MCP server responding correctly

4. Check inside your AI agent

Open VS Code with this project. Ask Claude Code:

"Which MCP servers do you have?"

You should see larkx in the list along with its 6 tools.

5. Ask a question that uses the tools

Try one of these prompts:

  • "Show me the project index."
  • "Where is the indexProject function defined?"
  • "What files import src/utils/crypto.ts?"

The AI should call get_project_index, search_symbol, or get_impact directly, without opening any source file.

Not working?Check the FAQ or open an issue on GitHub.