MCP server that indexes a codebase's public API at startup and serves it via compact tool responses. Pluggable parsers for C#, Java, TypeScript, Python, and more.
Project description
codesurface
MCP server that indexes your codebase's public API at startup and serves it via compact tool responses — saving tokens vs reading source files.
Parses source files, extracts public classes/methods/properties/fields/events, and serves them through 5 MCP tools. Works with Claude Code, Cursor, Windsurf, or any MCP-compatible AI tool.
Supported languages: C# (.cs), Java (.java), Python (.py), TypeScript/TSX (.ts, .tsx)
Quick Start
pip install codesurface
Then add to your .mcp.json:
{
"mcpServers": {
"codesurface": {
"command": "codesurface",
"args": ["--project", "/path/to/your/src"]
}
}
}
Point --project at any directory containing supported source files — a Unity Assets/Scripts folder, a Spring Boot project, a .NET src/ tree, a Node.js/React project, a Python package, etc. Languages are auto-detected.
Restart your AI tool and ask: "What methods does MyService have?"
Tools
| Tool | Purpose | Example |
|---|---|---|
search |
Find APIs by keyword | "MergeService", "BlastBoard", "GridCoord" |
get_signature |
Exact signature by name or FQN | "TryMerge", "CampGame.Services.IMergeService.TryMerge" |
get_class |
Full class reference card — all public members | "BlastBoardModel" → all methods/fields/properties |
get_stats |
Overview of indexed codebase | File count, record counts, namespace breakdown |
reindex |
Incremental index update (mtime-based) | Only re-parses changed/new/deleted files |
Tested On
| Project | Language | Files | Records | Time |
|---|---|---|---|---|
| vscode | TypeScript | 6,611 | 88,293 | 9.3s |
| Paper | Java | 2,909 | 33,973 | 2.3s |
| langchain | Python | 1,880 | 12,418 | 1.1s |
| pydantic | Python | 365 | 9,648 | 0.3s |
| guava | Java | 891 | 8,377 | 2.4s |
| immich | TypeScript | 919 | 7,957 | 0.6s |
| fastapi | Python | 881 | 5,713 | 0.5s |
| ant-design | TypeScript | 2,947 | 5,452 | 0.9s |
| dify | TypeScript | 4,903 | 5,038 | 1.9s |
| crawlee-python | Python | 386 | 2,473 | 0.3s |
| flask | Python | 63 | 872 | <0.1s |
| Unity game (private) | C# | 129 | 1,018 | 0.1s |
Benchmarks
Measured against a real Unity game project (129 files, 1,018 API records) across a 10-step cross-cutting research workflow.
| Strategy | Total Tokens | vs MCP |
|---|---|---|
| MCP (codesurface) | 1,021 | — |
| Skilled Agent (Grep + partial Read) | 4,453 | 4.4x more |
| Naive Agent (Grep + full Read) | 11,825 | 11.6x more |
Even with follow-up reads for implementation detail, the hybrid MCP + targeted Read approach uses 54% fewer tokens than a skilled Grep+Read agent.
See workflow-benchmark.md for the full step-by-step analysis.
Setup Details
Claude Code configuration
Add to <project>/.mcp.json:
Using uv (recommended):
{
"mcpServers": {
"codesurface": {
"command": "uv",
"args": ["run", "--directory", "/path/to/codesurface", "codesurface", "--project", "/path/to/your/src"]
}
}
}
Using pip install:
{
"mcpServers": {
"codesurface": {
"command": "codesurface",
"args": ["--project", "/path/to/your/src"]
}
}
}
CLAUDE.md snippet (recommended)
Add to your project's CLAUDE.md so the AI knows when to use the tools:
## Codebase API Lookup (codesurface MCP)
Use the `codesurface` MCP tools to look up your project's classes, methods, properties, and fields instead of reading source files.
| When | Tool | Example |
|------|------|---------|
| Searching for an API by keyword | `search` | `search("MergeService")` |
| Need exact method signature | `get_signature` | `get_signature("TryMerge")` |
| Want all members on a class | `get_class` | `get_class("BlastBoardModel")` |
| Overview of indexed codebase | `get_stats` | `get_stats()` |
| After creating/deleting source files | `reindex` | `reindex()` |
Project structure
codesurface/
├── src/codesurface/
│ ├── server.py # MCP server — 5 tools
│ ├── db.py # SQLite + FTS5 database layer
│ └── parsers/
│ ├── base.py # BaseParser ABC
│ ├── csharp.py # C# parser
│ ├── java.py # Java parser
│ ├── python_parser.py # Python parser
│ └── typescript.py # TypeScript/TSX parser
├── pyproject.toml
└── README.md
Troubleshooting
"No codebase indexed"
- Ensure
--projectpoints to a directory containing supported source files (.cs,.java,.py,.ts,.tsx) - The server indexes at startup — check stderr for the "Indexed N records" message
Server won't start
- Check Python version:
python --version(needs 3.10+) - Check
mcp[cli]is installed:pip install mcp[cli]
Stale results after editing source files
- Call
reindex()— only re-parses files whose modification time changed, fast even on large codebases
Contact
License
MIT
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file codesurface-0.4.0.tar.gz.
File metadata
- Download URL: codesurface-0.4.0.tar.gz
- Upload date:
- Size: 43.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7329b7ff8ca17a7aa5f935a0e70ccdae619c629097c4e4e8bb6d32f3295458a8
|
|
| MD5 |
db02c5e7e17abce3ff575193049d776c
|
|
| BLAKE2b-256 |
73e0aa95569e16ce3937fbd0586ae5175b9afe6a0876f1dc8af8edccccf7dcaf
|
Provenance
The following attestation bundles were made for codesurface-0.4.0.tar.gz:
Publisher:
publish.yml on Codeturion/codesurface
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
codesurface-0.4.0.tar.gz -
Subject digest:
7329b7ff8ca17a7aa5f935a0e70ccdae619c629097c4e4e8bb6d32f3295458a8 - Sigstore transparency entry: 999881769
- Sigstore integration time:
-
Permalink:
Codeturion/codesurface@8e8615fe3ad343c25e0786918a58fc5da5834caf -
Branch / Tag:
refs/tags/v0.4.0 - Owner: https://github.com/Codeturion
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@8e8615fe3ad343c25e0786918a58fc5da5834caf -
Trigger Event:
release
-
Statement type:
File details
Details for the file codesurface-0.4.0-py3-none-any.whl.
File metadata
- Download URL: codesurface-0.4.0-py3-none-any.whl
- Upload date:
- Size: 42.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
84ad64c5ed959e05b0f6708e05dcfc0b15fe6b4e07aab2fe6bca1a04210da547
|
|
| MD5 |
ddac0ac2a81775d98b491af635ac2598
|
|
| BLAKE2b-256 |
f4568f824f09de8fd5b9e9d9145aff854e494ea68173bb6d1515ca9330d8c5f0
|
Provenance
The following attestation bundles were made for codesurface-0.4.0-py3-none-any.whl:
Publisher:
publish.yml on Codeturion/codesurface
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
codesurface-0.4.0-py3-none-any.whl -
Subject digest:
84ad64c5ed959e05b0f6708e05dcfc0b15fe6b4e07aab2fe6bca1a04210da547 - Sigstore transparency entry: 999881833
- Sigstore integration time:
-
Permalink:
Codeturion/codesurface@8e8615fe3ad343c25e0786918a58fc5da5834caf -
Branch / Tag:
refs/tags/v0.4.0 - Owner: https://github.com/Codeturion
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@8e8615fe3ad343c25e0786918a58fc5da5834caf -
Trigger Event:
release
-
Statement type: