内容
# logpiper
[![npm]](https://www.npmjs.com/package/logpiper-mcp)
[npm]: https://img.shields.io/npm/v/logpiper-mcp.svg?style=flat-square
Logpiper 是一个 MCP 服务器和客户端,用于流式传输终端命令日志,并提供主动错误通知。
## 特性
🚀 **多会话支持**:可以在不同终端上同时运行多个 `logpiper` 实例
📊 **实时流式传输**:仅通过基于游标的流式传输提供新的、未获取的日志
📢 **主动通知**:自动向 Claude Code 发送警报
## 安装
安装 npm 包 `logpiper-mcp` 以访问两个组件:
```bash
npm install -g logpiper-mcp
```
这将提供:
- **CLI 工具**:用于日志收集的 `logpiper` 命令
- **MCP 服务器**:用于 IDE 集成的 `logpiper-mcp`
- **Claude Code 代理**:使用 `logpiper --install-agent` 安装监控代理
### 代理安装
要安装 Claude Code 监控代理:
```bash
logpiper --install-agent
```
这将通过交互式方式指导您将 logpiper-monitor 代理安装到 Claude Code 代理目录中。
### MCP 服务器配置
将 `logpiper` 添加到您的 IDE 配置中,例如 `~/.claude/settings.json`:
```json
{
"mcpServers": {
"logpiper": {
"command": "logpiper-mcp"
}
}
}
```
## 使用
### 1. 通过在命令前加上 `logpiper` 开始监控任何命令:
#### 测试和 CI/CD
```bash
# 监控测试套件
logpiper npm test
logpiper npm run test:watch
logpiper npm run test:e2e
# 监控构建过程
logpiper npm run build
logpiper npm run build:prod
```
#### Docker 和容器监控
```bash
# 监控 Docker Compose 服务
logpiper docker-compose up
logpiper docker-compose logs -f backend
# 监控单个容器
logpiper docker logs -f container_name
```
#### 数据库和后端服务
```bash
# 监控 Python 应用
logpiper python app.py
logpiper uvicorn main:app --reload
# 监控 Node.js 服务器
logpiper node server.js
logpiper nodemon app.js
```
### 3. 可用的 MCP 工具
| 工具 | 描述 | 用法 |
|------|-------------|-------|
| `get_new_logs` | 获取自游标位置以来的新日志(流式传输) | 实时日志监控 |
| `list_sessions` | 列出所有日志会话及其元数据 | 会话管理 |
| `search_logs` | 使用查询字符串搜索日志 | 错误调查 |
| `get_logs_paginated` | 获取带有基于游标的分页和自动分块的日志 | 大日志文件导航 |
| `cleanup_sessions` | 清理会话:基于标准的智能清理或完全重置 | 会话管理(模式:“smart” 或 “all”) |
### 其他特性
🔒 **令牌限制**:MCP 响应自动限制为 25,000 个令牌,以防止对 Claude Code 造成过载。
## 贡献
1. Fork 该仓库
2. 创建一个功能分支
3. 添加您的改进
4. 使用多种命令类型进行测试
5. 提交拉取请求
## 许可证
MIT 许可证 - 随意使用和修改以满足您的需求!