SimpleCodeMCP
将您的内部代码库转化为AI可访问的知识源。
SimpleCodeMCP是一个开源工具，它对内部代码库进行索引，并通过模型上下文协议（MCP）服务器公开它们。这使得AI编码代理（Claude、GitHub Copilot等）能够为公司内部库提供精确的、上下文感知的帮助，即使文档稀疏或过时。
问题
在许多组织中：
- 团队A 构建内部库（例如。，
pythonpackage1) - B组 使用这些库来实现新软件
- 文档往往不完整、过时或缺失
- 这会导致频繁的误用、实施错误和重复问题
解决方案
SimpleCodeMCP扫描并索引您的内部库：
- 公共和内部API
- 函数/类签名和类型提示
- 文档字符串和注释
- 测试（作为使用示例）
- 代码结构和关系
然后，它通过MCP服务器公开这些知识，AI代理可以向其查询：
- 列出可用的函数和类
- 检查签名和行为
- 从测试中检索实际使用示例
- 从语义上搜索代码库的相关部分
建筑
┌─────────────────────────────────────────────────────────┐
│ Your Library Repository │
│ ├── src/ (source code) │
│ ├── tests/ (usage examples) │
│ └── examples/ (additional examples) │
└────────────────────┬────────────────────────────────────┘
│
▼
┌──────────────────────┐
│ Indexer Component │
│ ───────────────── │
│ • AST Parser │ Extract structure
│ • Docstring Parser │ Extract documentation
│ • Test Parser │ Find usage patterns
│ • Static Analyzer │ Infer types & relationships
└──────────┬───────────┘
│
▼
┌──────────────────────┐
│ Storage Layer │
│ ───────────────── │
│ • ChromaDB │ Semantic search (embeddings)
│ • Metadata Store │ Signatures, paths, etc.
└──────────┬───────────┘
│
▼
┌──────────────────────┐
│ MCP Server │
│ (FastAPI + MCP SDK) │
│ ───────────────── │
│ Available Tools: │
│ • list_api │
│ • get_signature │
│ • search_code │
│ • get_examples │
│ • get_tests │
└──────────┬───────────┘
│
▼
┌──────────────────────┐
│ AI Agent (Client) │
│ Claude, Copilot, │
│ or any MCP client │
└──────────────────────┘特性
多语言支持
- python （MVP具有完整的AST解析、类型推理）
- C （计划中）
- JavaScript/TypeScript （计划中）
- Java （计划中）
- 去 （计划中）
- 适用于其他语言的可扩展架构
多个嵌入提供程序
- 本地 （句子转换）-免费、离线、隐私友好
- 开放人工智能 -高质量、快速、基于云
- Azure OpenAI -企业支持、数据驻留控制
看 嵌入式_提供者.md 以进行详细的比较和设置。
MCP工具
服务器向AI代理公开以下工具：
list_api
列出库中所有可用的函数、类和模块。
参数：
module（可选）：按特定模块/命名空间筛选
退货：
{
"functions": ["calculate_total", "validate_email"],
"classes": ["User", "Order"],
"modules": ["core", "utils", "api"]
}get_signature
检索函数或类的详细签名信息。
参数：
name：函数或类名
退货：
{
"name": "calculate_total",
"signature": "calculate_total(items: List[Item], tax_rate: float = 0.19) -> Decimal",
"docstring": "Calculate the total price including tax...",
"file": "src/billing.py",
"line": 45,
"parameters": [
{"name": "items", "type": "List[Item]", "required": true},
{"name": "tax_rate", "type": "float", "default": "0.19"}
],
"return_type": "Decimal"
}search_code
使用自然语言在代码库中进行语义搜索。
参数：
query：自然语言查询（例如，“如何验证电子邮件？”）limit（可选）：最大结果（默认值：10）
退货：
{
"results": [
{
"name": "validate_email",
"relevance_score": 0.92,
"signature": "validate_email(email: str) -> bool",
"docstring": "Validates email format using regex...",
"file": "src/utils/validation.py"
}
]
}get_examples
从测试和示例文件中检索使用示例。
参数：
name：函数或类名
退货：
{
"examples": [
{
"source": "tests/test_billing.py",
"code": "result = calculate_total(items=[item1, item2], tax_rate=0.19)\nassert result == Decimal('119.00')",
"description": "Basic usage with two items"
}
]
}get_tests
检索与函数或类相关的所有测试。
参数：
name：函数或类名
退货：
{
"tests": [
{
"test_name": "test_calculate_total_with_default_tax",
"file": "tests/test_billing.py",
"line": 12,
"code": "..."
}
]
}安装
对于用户
pip install simplecode-mcp为了发展
此项目使用 紫外线 快速Python包管理：
# Install uv
curl -LsSf https://astral.sh/uv/install.sh | sh
# Clone the repository
git clone https://github.com/yourusername/simplecode-mcp.git
cd simplecode-mcp
# Install dependencies and create virtual environment
uv sync
# Activate the virtual environment
source .venv/bin/activate # On Unix/macOS
# or
.venv\Scripts\activate # On Windows快速开始
1.为你的图书馆建立索引
创建配置文件 simplecode_mcp.yaml:
library:
name: "my-internal-lib"
path: "/path/to/my-internal-lib"
language: "python" # python, c++, javascript, typescript, java, go
include_private: true # Index _internal functions too
indexing:
trigger: "manual" # manual | on_commit | watch
embedding_model: "local" # local (sentence-transformers) | openai
server:
host: "localhost"
port: 8000
auth: null # Optional: bearer_token for authentication索引您的库：
simplecode-mcp reindex2.启动MCP服务器
simplecode-mcp serve服务器将于启动 http://localhost:8000.
3.连接您的AI代理
将MCP服务器添加到代理的配置中：
适用于克劳德桌面(claude_desktop_config.json):
{
"mcpServers": {
"my-internal-lib": {
"command": "simplecode-mcp",
"args": ["serve"],
"cwd": "/path/to/my-internal-lib"
}
}
}对于GitHub Copilot(mcp.json):
{
"servers": {
"my-internal-lib": {
"url": "http://localhost:8000"
}
}
}4.在IDE中使用
您的AI代理现在可以回答以下问题：
- “我如何使用
calculate_total功能？" - “显示电子邮件验证的示例”
- “什么参数
User类构造函数采取？"
配置选项
索引触发器
manual：运行simplecode-mcp reindex手动地on_commit：在git提交时自动重新索引（通过git钩子）watch：监视文件更改并自动重新索引
嵌入模型
local：使用句子变换器（例如。，all-MiniLM-L6-v2)
- 优点：没有外部API调用，离线工作 - 缺点：复杂查询的速度较慢，质量较低
openai：使用OpenAI的嵌入API
- 优点：快速、高质量 - 缺点：需要API密钥，不能完全离线
认证
对于公司内部使用，您可以启用承载令牌身份验证：
server:
auth:
type: "bearer"
token: "your-secret-token"用例
1.图书馆所有者视角
你维护一个10个团队使用的内部Python包。不要重复回答同样的问题：
- 在库上运行SimpleCodeMCP一次
- 与消费者团队共享MCP服务器端点
- 他们的人工智能代理现在可以自主回答有关图书馆的问题
2.图书馆消费者视角
您正在使用一个不熟悉的内部库实现一个新功能：
- 将您的AI代理连接到图书馆的MCP服务器
- 询问：“如何通过内部API进行身份验证？”
- 从库的测试中获取即时、准确的示例
3.引进新开发人员
新团队成员可以通过他们的人工智能助手探索内部库，而无需挖掘过时的维基或打扰高级开发人员。
路线图
MVP（v0.1）
- \[x\] Python支持（AST解析、文档字符串、测试）
- \[x\] 手动索引触发器
- \[x\] 局部嵌入模型（句子变换器）
- \[x\] 基本MCP工具（list_api、get_signature、search_code、get_examples）
- \[x\] YAML配置
未来版本
- \[\]增量索引（仅更改文件）
- \[\]C++支持
- \[\]支持JavaScript/TypeScript
- \[\]用于自动重新索引的Git挂钩
- \[\]文件监视器模式
- \[\]OpenAI嵌入支持
- \[\]高级相关性评分
- \[\]多版本支持（同时索引v1.x和v2.x）
- \[\]用于浏览索引库的Web UI
- \[\]与内部文档系统集成
贡献
欢迎投稿！此项目使用 紫外线 用于依赖性管理。
设置开发环境
# Install uv
curl -LsSf https://astral.sh/uv/install.sh | sh
# Clone and setup
git clone https://github.com/yourusername/simplecode-mcp.git
cd simplecode-mcp
uv sync
# Run tests
uv run pytest
# Run the CLI in development mode
uv run simplecode-mcp --help我们愿意帮助的领域
- 支持其他语言（JS/TS、Java、Go、Rust）
- 更好的测试示例提取
- 大型代码库的性能优化
- 替代嵌入模型
许可证
MIT许可证-请参阅 许可证 了解详情。
为什么选择“SimpleCodeMCP”？
因为复杂的内部库值得 简单，可访问的知识界面。不再有过时的文档，不再需要挖掘源代码——只需问问你的人工智能代理。
______________________________________________________________________
专为快速移动和破坏东西（但想破坏更少的东西）的团队而设计。