README
🚀 Dev-Env Sentinel MCP
Dev-Env Sentinel MCP 是一个轻量级、高效的 MCP 服务器,用于监控和验证开发环境的健康状况。它能帮助开发者及时发现并解决开发环境中存在的问题,确保开发工作的顺利进行。
✨ 主要特性
- 语言无关性:核心引擎可通过 YAML 配置文件与任何语言或工具协同工作。
- 配置驱动:所有特定工具的逻辑都存储在 YAML 文件中。
- 遵循 DRY/KISS 原则:使用共享工具,最大程度减少代码重复。
- 高效性:针对性能进行优化,内存占用低。
📦 安装指南
通过 npm/npx(推荐)
全局安装:
npm install -g dev-env-sentinel
或者使用 npx(无需安装):
npx dev-env-sentinel
针对 MCP 客户端
Cursor
将以下内容添加到 Cursor MCP 设置中(Linux/Mac 系统路径为 ~/.cursor/mcp.json,Windows 系统路径为 %APPDATA%\Cursor\mcp.json):
{
"mcpServers": {
"dev-env-sentinel": {
"command": "npx",
"args": ["-y", "dev-env-sentinel"]
}
}
}
如果是全局安装,可以这样配置:
{
"mcpServers": {
"dev-env-sentinel": {
"command": "dev-env-sentinel"
}
}
}
Claude Code
将以下内容添加到 Claude Code MCP 配置中:
{
"mcpServers": {
"dev-env-sentinel": {
"command": "npx",
"args": ["-y", "dev-env-sentinel"]
}
}
}
Google Antigravity
将以下内容添加到 Antigravity MCP 配置中:
{
"mcpServers": {
"dev-env-sentinel": {
"command": "npx",
"args": ["-y", "dev-env-sentinel"]
}
}
}
📚 详细文档
项目结构
dev-env-sentinel/
├── cmd/
│ └── sentinel/ # MCP 服务器入口点
├── internal/
│ ├── common/ # 共享工具(遵循 DRY 原则)
│ ├── config/ # 配置加载
│ ├── detector/ # 生态系统检测
│ ├── verifier/ # 构建新鲜度验证
│ ├── auditor/ # 依赖项/环境变量审计
│ └── reconciler/ # 自动修复功能
├── config/ # 配置文件
│ ├── languages/ # 语言级配置
│ │ └── *.yaml # 语言配置(如 java.yaml、python.yaml 等)
│ ├── tools/ # 特定语言工具配置
│ │ ├── java/ # Java 工具(Maven、Gradle、Spring 等)
│ │ ├── python/ # Python 工具(Poetry、Conda)
│ │ ├── javascript/ # JavaScript 工具(npm、React、Vite 等)
│ │ └── csharp/ # C# 工具(MSBuild、NuGet、dotnet CLI)
│ └── infrastructure/ # 基础设施工具
│ ├── docker/ # Docker 工具
│ ├── containers/ # 容器相关工具
│ └── databases/ # 数据库工具
│ └── postgres/ # PostgreSQL 工具
└── docs/ # 文档
核心原则
- DRY(不要重复自己):在
internal/common中使用共享工具。 - KISS(保持简单):功能聚焦,职责明确。
- 高效性:最小化内存分配,优化文件操作。
- 可扩展性:通过 YAML 配置文件添加新的生态系统。
开发
前提条件
- Go 1.13 及以上版本(支持 Go Modules)
- Node.js 14 及以上版本(用于构建脚本)
config/目录结构下的 YAML 配置文件
构建
为当前平台构建:
npm run build
为所有平台(Windows 和 Linux)构建:
npm run build:all
为特定平台构建:
npm run build:windows
npm run build:linux
或者直接使用 Go 进行构建:
go build ./cmd/sentinel
运行
运行 MCP 服务器(MCP 模式无需参数):
./sentinel
或者通过 npm 运行:
npx dev-env-sentinel
支持的生态系统
第一阶段(MVP)
- Java:Maven (
pom.xml)、Gradle (build.gradle) - npm:npm、Yarn、pnpm (
package.json)
第二阶段(已实现)
- React:React 应用程序 (
package.json包含 React) - Vite:Vite 构建工具 (
vite.config.js/ts) - Python:pip (
requirements.txt,setup.py) - Poetry:Poetry 包管理器 (
pyproject.toml,poetry.lock) - Conda:Conda 环境管理器 (
environment.yml) - Docker:Docker 和 Docker Compose (
Dockerfile,docker-compose.yml) - PostgreSQL:数据库配置和迁移
- C# (.NET):.NET 项目 (
*.csproj,*.sln)
构建工具和框架
- Webpack:Webpack 打包工具 (
webpack.config.js) - Rollup:Rollup 打包工具 (
rollup.config.js) - Sass/SCSS:Sass 预处理器 (
*.scss,*.sass) - Spring Framework:Spring Boot/Spring 框架 (
application.properties,pom.xml) - Apache Tomcat:Tomcat servlet 容器 (
web.xml,context.xml) - JBoss/WildFly:JBoss 应用服务器 (
jboss-web.xml,standalone.xml)
货币化与许可
Dev-Env Sentinel 使用带有功能标志的免费增值模式:
- 免费版:基本的验证和审计工具。
- 专业版:自动修复功能和高级特性。
- 企业版:Docker 编排和自定义配置。
快速开始
检查许可证状态:
# 通过 MCP 工具
check_license_status()
获取专业版许可证信息:
# 通过 MCP 工具
get_pro_license()
激活许可证:
# 通过 MCP 工具
activate_pro(license_key="your-license-key")
支付选项
- Stripe 支付链接 - 一次性或订阅支付。
- Apify 按事件付费 - 每次工具调用收费 $0.02 - $0.05。
详细信息请参阅 docs/monetization.md。
添加新的生态系统
添加一种语言
在 config/languages/ 目录下添加一个 YAML 配置文件,以支持基础语言(例如,config/languages/go.yaml)。
添加一个工具
对于特定语言的工具,在 config/tools/{language}/ 目录下添加一个 YAML 配置文件,其中 {language} 是该工具所使用的语言(例如,config/tools/java/maven.yaml)。
对于基础设施工具,将它们添加到 config/infrastructure/ 下的相应子目录中:
- Docker 工具:
config/infrastructure/docker/ - 容器工具:
config/infrastructure/containers/ - 数据库工具:
config/infrastructure/databases/{tool-name}/
无需更改代码 - 系统会自动发现所有配置!
架构详细信息请参阅 docs/architecture/configuration-schema.md。
微信扫一扫