Skip to content

Commit f96b9f1

Browse files
committed
docs: document tree-sitter usage and symbol references tool
- call out generic analyzer tree-sitter symbol extraction and guardrails - add get_symbol_references to README + capabilities tool list
1 parent b470709 commit f96b9f1

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
### Added
66

7+
- Tree-sitter-backed symbol extraction is now used by the Generic analyzer when available (with safe fallbacks).
8+
- New tool: `get_symbol_references` for concrete symbol usage evidence (usageCount + top snippets).
79
- Multi-codebase eval runner: `npm run eval -- <codebaseA> <codebaseB>` with per-codebase reports and combined summary.
810
- Shared eval scoring/reporting module (`src/eval/*`) used by both the CLI runner and the test suite.
911
- Second frozen eval fixture plus an in-repo controlled TypeScript codebase for fully-offline eval runs.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,7 @@ Record a decision once. It surfaces automatically in search results and prefligh
169169
| ------------------------------ | ----------------------------------------------------------------------------------------- |
170170
| `search_codebase` | Hybrid search with enrichment + preflight. Pass `intent="edit"` for edit readiness check. |
171171
| `get_team_patterns` | Pattern frequencies, golden files, conflict detection |
172+
| `get_symbol_references` | Find concrete references to a symbol (usageCount + top snippets) |
172173
| `get_component_usage` | "Find Usages" - where a library or component is imported |
173174
| `remember` | Record a convention, decision, gotcha, or failure |
174175
| `get_memory` | Query team memory with confidence decay scoring |

docs/capabilities.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,18 @@ Technical reference for what `codebase-context` ships today. For the user-facing
44

55
## Tool Surface
66

7-
10 MCP tools + 1 optional resource (`codebase://context`).
7+
11 MCP tools + 1 optional resource (`codebase://context`).
88

99
### Core Tools
1010

11-
| Tool | Input | Output |
12-
| --------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
13-
| `search_codebase` | `query`, optional `intent`, `limit`, `filters`, `includeSnippets` | Ranked results (`file`, `summary`, `score`, `type`, `trend`, `patternWarning`) + `searchQuality` (with `hint` when low confidence) + `preflight` ({ready, reason}). Snippets opt-in. |
14-
| `get_team_patterns` | optional `category` | Pattern frequencies, trends, golden files, conflicts |
15-
| `get_component_usage` | `name` (import source) | Files importing the given package/module |
16-
| `remember` | `type`, `category`, `memory`, `reason` | Persists to `.codebase-context/memory.json` |
17-
| `get_memory` | optional `category`, `type`, `query`, `limit` | Memories with confidence decay scoring |
11+
| Tool | Input | Output |
12+
| ----------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
13+
| `search_codebase` | `query`, optional `intent`, `limit`, `filters`, `includeSnippets` | Ranked results (`file`, `summary`, `score`, `type`, `trend`, `patternWarning`) + `searchQuality` (with `hint` when low confidence) + `preflight` ({ready, reason}). Snippets opt-in. |
14+
| `get_team_patterns` | optional `category` | Pattern frequencies, trends, golden files, conflicts |
15+
| `get_symbol_references` | `symbol`, optional `limit` | Concrete symbol usage evidence: total `usageCount` + top usage snippets |
16+
| `get_component_usage` | `name` (import source) | Files importing the given package/module |
17+
| `remember` | `type`, `category`, `memory`, `reason` | Persists to `.codebase-context/memory.json` |
18+
| `get_memory` | optional `category`, `type`, `query`, `limit` | Memories with confidence decay scoring |
1819

1920
### Utility Tools
2021

0 commit comments

Comments
 (0)