article
README
🚀 Gradle Tomcat MCP Server
Gradle Tomcat MCP Server 是一个模型上下文协议(MCP)服务器,用于管理基于 Gradle 的 Tomcat 应用程序,并且具备日志查询功能。
✨ 主要特性
- 进程管理:通过 Gradle 启动、停止、重启和监控 Tomcat 进程。
- 日志管理:捕获、存储和过滤查询应用程序日志。
- 实时监控:流式传输日志和进程状态更新。
- MCP 集成:与 Claude 和其他 MCP 客户端完全集成。
📦 安装指南
全局安装(推荐)
npm install -g mcp-gradle-tomcat
本地安装
npm install mcp-gradle-tomcat
从源代码安装
git clone https://github.com/your-username/mcp-gradle-tomcat.git
cd mcp-gradle-tomcat
npm install
🚀 快速开始
1. 添加到 Claude 配置
将以下内容添加到你的 Claude 配置文件(~/.claude/config.json)中:
{
"mcpServers": {
"gradle-tomcat": {
"command": "mcp-gradle-tomcat",
"env": {
"GRADLE_WORKING_DIR": "/path/to/your/gradle/project"
}
}
}
}
2. 与 Claude 配合使用
配置完成后,你可以在 Claude 中使用以下命令:
- “启动 Tomcat” - 启动你的 Gradle 应用程序。
- “停止 Tomcat” - 优雅地停止正在运行的应用程序。
- “获取 Tomcat 状态” - 显示进程状态和运行时间。
- “获取最近的日志” - 过滤检索应用程序日志。
- “重启 Tomcat” - 停止并重新启动应用程序。
💻 使用示例
直接执行
# 设置你的项目目录
export GRADLE_WORKING_DIR="/path/to/your/gradle/project"
# 运行 MCP 服务器
mcp-gradle-tomcat
测试工具
# 测试单个工具
npm test
📚 详细文档
配置
可以通过环境变量进行配置:
| 属性 | 详情 |
|------|------|
| GRADLE_WORKING_DIR | Gradle 命令的工作目录(默认:当前目录) |
| GRADLE_COMMAND | 要运行的 Gradle 命令(默认:appRun) |
| TOMCAT_PORT | 预期的 Tomcat 端口(默认:8080) |
| MAX_LOG_BUFFER_SIZE | 内存中最大日志条目数(默认:1000) |
| LOG_DIR | 日志文件的目录(默认:./logs) |
可用工具
start_tomcat
通过 Gradle 启动 Tomcat
gradle_command(可选):要运行的 Gradle 命令working_directory(可选):工作目录
stop_tomcat
终止 Tomcat 进程
force(可选):使用 SIGKILL 强制终止
restart_tomcat
停止并启动 Tomcat
force(可选):停止期间强制终止gradle_command(可选):重启时的 Gradle 命令
get_tomcat_status
检查 Tomcat 进程状态
- 无参数
get_logs
检索日志条目
lines(可选):最近的日志行数(默认:100)level(可选):最小日志级别(DEBUG、INFO、WARN、ERROR)since(可选):用于过滤的 ISO 8601 时间戳source(可选):按来源过滤(stdout、stderr)
clear_logs
清除日志缓冲区和文件
confirm(必需):必须为 true 才能确认
🔧 技术细节
架构
src/
├── server.js # 主 MCP 服务器
├── process-manager.js # Tomcat 生命周期管理
├── log-manager.js # 日志捕获和查询
├── tools/ # MCP 工具实现
└── config.js # 配置管理
📄 许可证
本项目采用 MIT 许可证。
微信扫一扫