article
README
🚀 NetContext上下文服务器
NetContext上下文服务器是一款提供代码仓库上下文的工具,支持通过命令行访问。它借助实现模型上下文协议 (MCP),让AI编程助手能更精准地生成和协助编写代码,还具备可配置忽略模式与敏感文件安全保护机制。
🚀 快速开始
基本操作
- 设置基目录:
dotnet run --project src/NetContextClient.csproj -- set-base-dir --directory "D:\Projects\MyApp"
- 检查版本和配置:
dotnet run --project src/NetContextClient.csproj -- version
其他操作示例
- 添加自定义忽略模式:
dotnet run --project src/NetContextClient.csproj -- add-ignore-patterns --patterns "*.generated.cs" "*.designer.cs"
- 列出所有项目:
dotnet run --project src/NetContextClient.csproj -- list-projects-in-dir --directory "D:\Projects\MyApp\src"
- 分析依赖项:
dotnet run --project src/NetContextClient.csproj -- analyze-packages
- 搜索代码:
dotnet run --project src/NetContextClient.csproj -- semantic-search --query "user authentication and authorization logic"
✨ 主要特性
- 代码索引:支持语义搜索,基于代码含义查找相关内容。
- 上下文提供:通过MCP协议为AI工具提供完整的项目上下文。
- 忽略模式:可自定义文件和目录的忽略规则。
- 安全保护:内置敏感文件保护机制。
📦 安装指南
- 克隆仓库:
git clone https://github.com/your-repository.git - 安装依赖:
.NET SDK 7.0+ 已预装依赖 - 启动服务:
dotnet run --project NetContextServer.csproj
📚 详细文档
与AI编程工具的集成
NetContextServer实现了MCP协议,支持以下工具:
- VS Code:配置VS Code使用NetContextServer作为MCP提供商。
- 其他符合MCP标准的工具。
配置VS Code
- 打开设置界面。
- 配置AI助手使用NetContextServer地址。
安全特性
- 路径安全:仅允许访问基目录内的文件。
- 模式验证:忽略模式语法正确性检查。
- 大小限制:大文件内容自动截断以防止内存溢出。
- 敏感文件保护:内置模式保护常见敏感文件类型。
示例工作流程
- 设置基目录:
dotnet run --project src/NetContextClient.csproj -- set-base-dir --directory "D:\Projects\MyApp"
- 检查服务器版本和配置:
dotnet run --project src/NetContextClient.csproj -- version
- 添加自定义忽略模式:
dotnet run --project src/NetContextClient.csproj -- add-ignore-patterns --patterns "*.txt" "*.log"
- 列出所有项目:
dotnet run --project src/NetContextClient.csproj -- list-projects-in-dir --directory "D:\Projects\MyApp\src"
- 分析依赖项:
dotnet run --project src/NetContextClient.csproj -- analyze-packages
错误处理
常见错误
- 找不到基目录:确保路径正确且存在。
- 未安装 .NET SDK:安装最新版 .NET SDK (7.0+)。
- 权限问题:检查文件夹权限,确保有读取权限。
贡献指南
- 提交代码前,请确保通过单元测试。
- 代码格式遵循C#编码规范。
- 提交PR前,请阅读贡献准则文档。
📄 许可证
项目使用MIT许可证,具体条款请参考 LICENSE 文件。
文档联系方式
如有任何问题,请联系:your.email@example.com
更多详细信息,请访问项目主页:https://github.com/your-repository
Scan to join WeChat group