使用说明
项目简介
Tailpipe MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,它作为 AI 助手(如 Claude、Cursor)与您的云和 SaaS 日志数据之间的桥梁。通过 Tailpipe MCP Server,AI 助手可以使用自然语言来查询、分析和探索您的日志数据,从而实现安全事件调查、成本和性能洞察、以及查询开发辅助等功能。
主要功能点
- 数据访问能力: 通过集成的 Tailpipe CLI 工具,安全地连接和读取您的 CloudTrail、Kubernetes 等云服务日志以及其他 SaaS 日志数据。
- 工具集成: 提供了一系列工具,允许 AI 助手执行数据库查询、管理数据连接、查看数据结构信息(如表、分区、插件、数据源等),从而深入探索数据。
- Prompt 模板: 内置最佳实践 Prompt,指导 AI 助手如何有效地与 Tailpipe 数据进行交互,提升分析效率。
- 状态监控: 提供 "status" 资源,允许 AI 助手检查 Tailpipe 连接状态和服务器信息。
- 易于集成: 通过简单的 JSON 配置,即可将 Tailpipe MCP Server 集成到支持 MCP 协议的 AI 助手。
安装步骤
- 安装 Node.js: 确保您的系统已安装 Node.js v16 或更高版本(包含 npm)。
- 安装 Tailpipe CLI: 您需要先安装并配置 Tailpipe 命令行工具,Tailpipe MCP Server 依赖 Tailpipe CLI 来访问和处理日志数据。
- 安装 Tailpipe MCP Server: 无需手动安装,Tailpipe MCP Server 通常以 npm 包的形式直接通过 AI 助手的配置启动。
服务器配置
要将 Tailpipe MCP Server 集成到您的 AI 助手,您需要在 AI 助手的配置文件中添加 MCP 服务器配置。以下是通用的配置信息,请根据您的 AI 助手类型(Claude Desktop, Cursor 等)参考 README.md 中的 AI Assistant Setup 部分,找到对应的配置文件位置和更详细的指南。
{ "mcpServers": { "tailpipe": { "command": "npx", "args": [ "-y", "@turbot/tailpipe-mcp" ], "serverName": "tailpipe" // 服务器名称,可自定义 } } }
- 'command': 启动 Tailpipe MCP Server 的命令,通常为 'npx',用于执行 npm 包。
- 'args': 传递给 'npx' 的参数,'"-y", "@turbot/tailpipe-mcp"' 表示执行 '@turbot/tailpipe-mcp' npm 包。
- 您可以选择在 'args' 中添加 Tailpipe 数据库文件的路径,例如 '["-y", "@turbot/tailpipe-mcp", "/path/to/your/tailpipe.db"]'。如果不指定路径,Tailpipe MCP Server 将尝试使用 Tailpipe CLI 自动发现数据库。
- 'serverName': MCP 服务器的名称,用于在 AI 助手配置中标识和引用该服务器。
基本使用方法
- 启动 AI 助手: 确保您的 AI 助手已配置 Tailpipe MCP Server 并已成功启动。
- 运行 'best_practices' Prompt: 首次使用时,建议先运行 'best_practices' Prompt,让 AI 助手学习如何有效地与 Tailpipe 数据交互。您可以通过 AI 助手的 MCP 功能调用名为 'best_practices' 的 Prompt。
- 自然语言查询: 现在,您可以直接使用自然语言向 AI 助手提问,例如:
- 'What tables do we have available in Tailpipe?' (Tailpipe 中有哪些表?)
- 'Show me all S3 bucket creation events from CloudTrail in the last 24 hours' (展示过去 24 小时内 CloudTrail 中所有 S3 bucket 创建事件)
- 'What were my top 10 AWS services by cost last month?' (上个月成本最高的 10 个 AWS 服务是什么?)
AI 助手将利用 Tailpipe MCP Server 提供的工具和数据访问能力,将您的自然语言问题转换为对日志数据的查询和分析,并将结果返回给您。
提示:
- 在查询时,尽量明确指定时间范围和数据类型(例如 CloudTrail 事件、成本数据等)。
- 从简单的查询开始,逐步增加复杂条件。
- 充分利用自然语言,AI 助手会自动处理 SQL 转换。
- 大胆探索,发现日志数据中的价值。
信息
分类
数据库与文件