Skip to content

Commit 9f95335

Browse files
committed
Update README
1 parent c0a196a commit 9f95335

3 files changed

Lines changed: 54 additions & 0 deletions

File tree

‎.github/copilot-instructions.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## vexp context tools <!-- vexp v1.2.30 -->
2+
3+
**MANDATORY: use `run_pipeline` — do NOT grep, glob, or read files manually.**
4+
vexp returns pre-indexed, graph-ranked context in a single call.
5+
6+
### Workflow
7+
1. `run_pipeline` with your task description — ALWAYS FIRST (replaces all other tools)
8+
2. Make targeted changes based on the context returned
9+
3. `run_pipeline` again only if you need more context
10+
11+
### Available MCP tools
12+
- `run_pipeline` — **PRIMARY TOOL**. Runs capsule + impact + memory in 1 call.
13+
Auto-detects intent. Includes file content. Example: `run_pipeline({ "task": "fix auth bug" })`
14+
- `get_context_capsule` — lightweight, for simple questions only
15+
- `get_impact_graph` — impact analysis of a specific symbol
16+
- `search_logic_flow` — execution paths between functions
17+
- `get_skeleton` — compact file structure
18+
- `index_status` — indexing status
19+
- `get_session_context` — recall observations from sessions
20+
- `search_memory` — cross-session search
21+
- `save_observation` — persist insights (prefer run_pipeline's observation param)
22+
23+
### Agentic search
24+
- Do NOT use built-in file search, grep, or codebase indexing — always call `run_pipeline` first
25+
- If you spawn sub-agents or background tasks, pass them the context from `run_pipeline`
26+
rather than letting them search the codebase independently
27+
28+
### Smart Features
29+
Intent auto-detection, hybrid ranking, session memory, auto-expanding budget.
30+
31+
### Multi-Repo
32+
`run_pipeline` auto-queries all indexed repos. Use `repos: ["alias"]` to scope. Run `index_status` to see aliases.
33+
<!-- /vexp -->

‎.vscode/mcp.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"servers": {
3+
"vexp": {
4+
"type": "stdio",
5+
"command": "/Users/larah/.nvm/versions/node/v22.20.0/bin/node",
6+
"args": [
7+
"/Users/larah/.vscode/extensions/vexp.vexp-vscode-1.2.30/dist/mcp-server.cjs"
8+
]
9+
}
10+
}
11+
}

‎README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@ Most repos have a documentation problem that gets worse as the codebase grows. K
66

77
This is a proposal for a lightweight, in-repo documentation system designed to serve both audiences, with no proprietary tooling and minimal maintenance overhead.
88

9+
I designed it specifically to solve a problem where engineers want to adopt AI in a token-efficient way, but they don’t want to mess around with complicated AGENT.md files, manually maintaining file frontmatter, or setting up skills. So the idea is that they have a standard pattern where they have internal docs in the repo in a `docs/` folder. Coding agents can find the docs, but they often sample all of them and waste tokens. Many teams are also reluctant to adopt new tools or add any sort of overhead.
10+
11+
So, my thinking was to create a very simple system that:
12+
13+
- Let agents use existing in-repo docs in a token-efficient way (using frontmatter that’s pulled into the AGENTS.md file to tell agents which docs to use based on the context).
14+
- Have a CI/CD workflow that minimizes the effort required of the engineering team to keep the system running. It does this by:
15+
- Automatically flagging stale docs
16+
- Automatically generating useful descriptions for docs (using an LLM)
17+
- Automatically maintaining routing info for all docs in the AGENTS.md file
18+
919
## How it works
1020

1121
The system has three parts that work together:

0 commit comments

Comments
 (0)