Permettez aux agents de codage IA d'inspecter la structure des dépôts, de rechercher du code et de mémoriser les conventions de projet via MCP et CLI.
Aussi connu sous PatrickSys/codebase-context
- Étoiles
- 68
- Outils
- —
- Téléchargements, 30 jours
- —
- Dernière version
- —
- Dernier commit
- 7 nov. 2026
- Licence
- —
Qu'est-ce que Codebase Context MCP ?
Codebase Context est un serveur MCP. Permettez aux agents de codage IA d'inspecter la structure des dépôts, de rechercher du code et de mémoriser les conventions de projet via MCP et CLI.
Résumé généré à partir du README du projet
À propos du MCP server Codebase Context
Codebase-context permet d'aider les agents de codage IA à comprendre des dépôts complexes grâce à des outils spécialisés d'indexation et de récupération. Les développeurs utilisent cet outil pour fournir aux agents une carte de haut niveau du dépôt, des références de symboles et des relations entre fichiers, permettant ainsi à une IA d'inspecter la structure d'un projet avant de tenter toute modification. Il fonctionne localement via stdio ou via une configuration HTTP avancée, et peut être initialisé pour des clients spécifiques comme Claude Code, Cursor, Codex et OpenCode.
Les utilisateurs peuvent choisir entre un index par défaut basé sur des mots-clés qui ne nécessite ni clé API ni GPU, ou un mode d'indexation sémantique optionnel utilisant des fournisseurs d'embeddings. Le système inclut des fonctionnalités uniques comme la mémoire de projet pour stocker les conventions et un outil de contexte de révision qui crée un paquet limité à partir des diffs Git. Bien que l'index par mots-clés soit limité par défaut à 5 000 segments de recherche, les utilisateurs peuvent ajuster ces limites via la configuration. Il propose des analyseurs spécifiques pour des frameworks tels que React, Next.js, Angular et NestJS afin d'améliorer la navigation des agents dans les bases de code.
Ce que vous pouvez faire avec
- 1Cartographier la structure du dépôtDemandez à un agent IA de générer une vue d'ensemble de haut niveau de l'organisation et des patterns du projet avant de commencer une tâche.
- 2Rechercher du code spécifiqueDirigez une IA pour trouver des symboles ou des fonctionnalités spécifiques au sein de la base de code en utilisant des résultats de recherche classés.
- 3Mémoriser les conventions du projetDonnez l'instruction à un agent de récupérer des décisions précédemment stockées ou des règles architecturales en utilisant les outils de mémoire.
- 4Analyser les changements récentsFournissez à une IA le contexte nécessaire provenant d'un commit récent pour effectuer une revue de code ciblée.
Extrait du README du projet. Chaque cas d'utilisation est vérifié par rapport à une citation du document.
Comment installer Codebase Context MCP
Formats vérifiés le 10 nov. 2026Ajouter à CursorAjouter à GooseInstaller Codebase Context MCP dans Claude Code
$ claude mcp add codebase-context -- npx -y codebase-contextInstaller Codebase Context MCP dans Cursor
~/.cursor/mcp.json
{
"mcpServers": {
"codebase-context": {
"command": "npx",
"args": [
"-y",
"codebase-context"
]
}
}
}Installer Codebase Context MCP dans VS Code
.vscode/mcp.json
{
"servers": {
"codebase-context": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"codebase-context"
]
}
}
}Installer Codebase Context MCP dans VS Code CLI
$ code --add-mcp '{"name":"codebase-context","type":"stdio","command":"npx","args":["-y","codebase-context"]}'Installer Codebase Context MCP dans Claude Desktop
claude_desktop_config.json
{
"mcpServers": {
"codebase-context": {
"command": "npx",
"args": [
"-y",
"codebase-context"
]
}
}
}Installer Codebase Context MCP dans Codex
$ codex mcp add codebase-context -- npx -y codebase-contextInstaller Codebase Context MCP dans Codex config.toml
~/.codex/config.toml
[mcp_servers.codebase-context] command = "npx" args = ["-y", "codebase-context"]
Installer Codebase Context MCP dans Gemini CLI
$ gemini mcp add -s user codebase-context npx -- -y codebase-contextInstaller Codebase Context MCP dans Gemini settings.json
~/.gemini/settings.json
{
"mcpServers": {
"codebase-context": {
"command": "npx",
"args": [
"-y",
"codebase-context"
]
}
}
}Vérifications automatisées
Exécuté le 13 nov. 2026Rapport complet →A passé nos vérifications automatisées. Il ne s'agit pas d'un audit de sécurité : lisez le code et donnez au serveur l'accès le plus restreint dont il a besoin. Fonctionnement des vérifications · Ce qu'il faut corriger pour gagner des points
- Dépôt source lié et accessiblepatricksys/codebase-context is public and reachablegithub.com/patricksys/codebase-context ↗Réussi
- Le nom du package correspond au dépôt sourcecodebase-context names patricksys/codebase-context as sourcenpmjs.com/package/codebase-context ↗Réussi
- Provenance du build (attestation Sigstore)Sigstore attestation for codebase-contextnpmjs.com/package/codebase-context/v/2.2.0#provenance ↗Réussi
- Licence open source (OSI)No licenseFaille
- Commit ou version publiée au cours de l'année écouléeLast commit or release 2026-11-07github.com/patricksys/codebase-context ↗Réussi
- OpenSSF ScorecardNon vérifié
- Nom du package non proche d'un package populaireNo popular package one edit away from codebase-contextRéussi
- Aucun avis critique dans le package ou ses dépendancesNon vérifié
- Aucune instruction cachée destinée au modèle0 tool descriptions and the README read; no override phrases, credential paths or hidden charactersRéussi
- Les outils destructifs sont étiquetésNon vérifié
- Le point de terminaison distant répond à la poignée de main MCPNon vérifié
README
Voir sur GitHubCodebase Context
Local repository maps, code search and symbol references for coding agents. Codebase Context exposes these through MCP and a CLI so an agent can inspect the repository before editing it.
Published beta: 2.3.1-beta.0 (stable: 2.2.0)
As checked on 4 November 2026, npm beta points to 2.3.1-beta.0, while npm latest remains 2.2.0. The beta requires Node.js 22 or newer. An unpinned npx -y codebase-context may use an already installed local version; without one, it resolves npm latest (currently the stable 2.2.0). To select the published beta explicitly, use npx -y codebase-context@2.3.1-beta.0 --version. A source checkout or a local tarball is separate from a verified registry release.
Fresh beta indexes use keyword search without downloading an embedding or reranker model. Existing indexes keep their recorded mode. Semantic indexing is an explicit option; its optional runtimes and model downloads are separate from the default path.
Try the beta or a local build from the terminal
Use an explicitly installed 2.3.1-beta.0, a built checkout (pnpm install, then pnpm build in the CBC checkout) or an installed local tarball. From the repository you want to inspect, point Node at that installation's actual entrypoint:
node /path/to/codebase-context/dist/index.js --version
node /path/to/codebase-context/dist/index.js map
node /path/to/codebase-context/dist/index.js search --query "a symbol or feature in this repository" --limit 5
node /path/to/codebase-context/dist/index.js status
Replace the paths and query with your own. For a tarball installed under /path/to/cbc-local, the entrypoint is /path/to/cbc-local/node_modules/codebase-context/dist/index.js. Quote paths containing spaces.
map builds an index when the folder has no previous index. It then returns a bounded repository map. Search returns ranked source locations; open the returned code before relying on it. Low confidence means weak matching evidence, not that an implementation is absent.
To refresh the index, use reindex. Omitting mode flags preserves the recorded mode; reindex --no-embeddings explicitly selects keyword-only indexing. reindex --embeddings selects the configured embedding provider and requires optional LanceDB storage. The default local provider also requires Transformers and may download models; an explicitly configured remote provider has its own connection requirements. Changing modes requires a full rebuild, including when --incremental is supplied.
Set up your AI client
From the target repository, the installed beta or built source can write project registrations for selected detected clients:
node /path/to/codebase-context/dist/index.js init
# Or select one client explicitly:
node /path/to/codebase-context/dist/index.js init --client codex --root /path/to/project --yes
The wizard recognizes Claude Code, Codex, Cursor and OpenCode. It saves the Node binary and package entrypoint that ran setup. If that installation or its npx cache is moved or removed, rerun setup. Writing a config does not prove that a native client connected or completed a coding task.
After registration, restart the client and ask:
Use Codebase Context to find [feature] in this repository. Pass this repository's absolute path as project, wait for indexing if needed, and open the relevant source files.
The client setup guide contains beta setup instructions and dated checks for the older stable package. Historical manual recipes, including Windsurf, retain their dated verification limits. For example, the following manual registration leaves the package version unpinned; it may use an already installed local version or fall back to npm latest, so it does not reliably select the beta:
claude mcp add --scope user --transport stdio codebase-context -- npx -y codebase-context
The default transport is stdio: the client starts the server. HTTP is an advanced option with client-specific setup. Explicit project selection is the portable default. A successful selection becomes active for later calls in that server process; select again after restarting or changing repositories.
What your agent can inspect
- Repository map: structure, detected patterns and example files before narrowing to a task.
- Code search: bounded, ranked results with source locations and search-quality information. The default compact response contains at most six results.
- Symbol references: static identifier occurrences. They are not a runtime call graph.
- File relationships: TypeScript/JavaScript imports and re-exports, with unresolved or stale edges reported. Python and Go import navigation are not supported.
- Team patterns: file-level frequencies and example files. These are observations about the repository, not prescriptions about code quality.
- Project memory:
rememberandget_memorystore and retrieve project conventions, decisions, gotchas and failures. - Review context:
codebase-context-reviewbuilds a bounded packet from a committed Git diff. It does not review code or establish reviewer quality. The review-context guide retains a separate historical version preview; it is not evidence of this candidate's publication.
Dedicated analyzers in the source cover Angular, React, Next.js and NestJS. Other files use the generic analyzer and available parsers. See the capabilities reference for scope and limitations.
Privacy and storage
The default keyword index is built locally. Docker, a GPU and an API key are not required. Optional local embeddings also run on the machine. If you explicitly configure a remote embedding provider, code chunks are sent to that provider.
Your AI client may send returned code to its own model provider; CBC does not control that connection. Project memory also travels with the repository if you commit and push it.
Generated index data should stay out of version control. To share project memory while ignoring the generated index:
.codebase-context/*
!.codebase-context/memory.json
Evidence and limits
The benchmark report and prior report archive describe separate historical experiments. These are retrieval observations, not a winner or a coding-quality claim. This historical evidence does not establish patch correctness or end-to-end coding quality. Versions, fixtures and failure records matter; these reports do not certify this candidate. This draft makes no claim that CBC beats text search, improves coding outcomes, or reduces time or tokens.
The default keyword path can miss natural-language questions when their vocabulary differs from the code. A returned file and a high score are not proof that an answer is correct. Inspect the cited implementation. Optional semantic search has not established a retrieval-quality advantage for this candidate.
Other practical limits:
- The default keyword index holds at most 5,000 searchable chunks per project.
projects[].parsing.maxChunkscan raise that limit. - Search has bounded candidate inspection. Narrow a query when the candidate budget is exhausted; refresh when source files changed or became unavailable.
- Existing formats or incomplete generations can require an explicit rebuild or recovery choice. A failed operation is not a successful recovery.
- Setup evidence differs by client. Config writing, protocol connectivity and native-client task completion are separate checks.
- Stdio routing checks do not establish concurrent HTTP client isolation.
Reference
- Client setup — candidate registration, dated checks and limits
- Capabilities — tools, routing, configuration and optional modes
- CLI — local-candidate commands and historical illustrations
- Benchmark — historical methods, observations and failures
- Contributing — local development and evaluation commands
- Changelog — candidate changes and historical entries
Elastic-2.0. See LICENSE.
Questions sur Codebase Context MCP
Comment ajouter Codebase Context MCP à Claude Code ?
Exécutez claude mcp add codebase-context -- npx -y codebase-context dans votre terminal. Ajoutez --scope user pour le rendre disponible dans tous les projets.
Comment ajouter Codebase Context MCP à Cursor ?
Ouvrez ~/.cursor/mcp.json et ajoutez le serveur sous mcpServers, avec la configuration Cursor indiquée dans la section d'installation ci-dessus.
Que peut inspecter un agent IA avec Codebase Context ?
L'agent peut consulter une carte du dépôt, effectuer des recherches de code classées, rechercher des références de symboles et des relations entre fichiers, observer les patterns de l'équipe, et stocker ou récupérer la mémoire du projet.
Codebase Context nécessite-t-il Docker, un GPU ou une clé API ?
Non. L'indexation par mots-clés par défaut s'effectue localement sans Docker, sans GPU et sans clé API. Les embeddings optionnels s'exécutent également localement, sauf si vous configurez explicitement un fournisseur distant.
Quels clients IA peuvent être configurés automatiquement par Codebase Context ?
L'assistant d'initialisation reconnaît Claude Code, Codex, Cursor et OpenCode et rédige les enregistrements de projet correspondants.
Combien de résultats une recherche de code par défaut renvoie-t-elle ?
La réponse de recherche compacte par défaut contient au maximum six résultats classés.
Les données d'index générées doivent-elles être soumises au contrôle de version ?
Non. Vous devez exclure les données d'index générées du contrôle de version et pouvez optionnellement ne soumettre que le fichier de mémoire du projet.