Getting Started
Verify setup
Quick sanity checks.
Check the CLI
bash
larkx --version
# → larkx v0.1.0If the command is not found, make sure your Node global bin is on PATH.
Check the index
bash
larkx statsShould print file counts, detected frameworks, and per-level token estimates.
If the index is empty, run larkx index first.
Check the MCP server
bash
larkx mcp --check
# → ✓ MCP server responding correctlyThis confirms the MCP server can start and answer basic JSON-RPC health checks.
Check the context file
bash
cat .larkx/context.mdThe file should exist and contain a compact project snapshot. If it is missing or empty, run larkx index.
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 with its 6 tools.
Run a tool diagnostic
Ask the AI to use larkx tools instead of opening source files:
- Call
get_project_indexand report the file count. - Pick a function name from that result and call
search_symbol. - Call
get_file_summaryon any indexed file. - Call
get_dead_codeand report how many dead nodes are found.
The agent should return real data for every step and should not read raw source files first.
Not working?
- Run larkx init if .mcp.json or instruction files are missing.
- Reload VS Code: Ctrl+Shift+P → Developer: Reload Window.
- Run larkx index --force to rebuild the index.
- Confirm .larkx/context.md exists for file-based agents.
- For Claude Code, verify .claude/settings.json includes a UserPromptSubmit hook.