使用说明
项目简介
CloudWatch Logs MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在为大型语言模型(LLM)应用提供访问和查询 AWS CloudWatch Logs 日志数据的能力。通过此服务器,LLM 可以安全、便捷地获取 CloudWatch 日志信息,从而增强 LLM 在日志分析、监控告警等方面的应用能力。
主要功能点
- 列出日志组 (list_groups): 允许 LLM 获取 AWS CloudWatch 中可用的日志组列表,支持按名称前缀过滤。
- 获取日志 (get_logs): 允许 LLM 从指定的日志组中检索日志条目,支持按日志流、时间范围和关键词进行过滤查询。
- AWS 认证支持: 支持通过 AWS 访问密钥 ID 和密钥进行身份验证,也支持使用默认的 AWS 凭证配置。
安装步骤
- 环境准备: 确保已安装 Python 3 环境。
- 下载代码: 从 GitHub 仓库 cloudwatch-logs-mcp 下载或克隆代码到本地。
- 安装依赖: 在代码根目录下,运行命令 'pip install -r main.py' 安装项目所需的 Python 依赖库 (包括 'mcp' 和 'boto3')。
服务器配置
MCP 服务器需要配置在 MCP 客户端 (如 Claude Desktop) 的配置文件中。以下是 'claude_desktop_config.json' 的配置示例,用于启动 CloudWatch Logs MCP Server:
{ "mcpServers": { "cloudwatch-logs": { "command": "python3", "args": ["/path/to/cloudwatch-logs-mcp/main.py"] } } }
- 'server name': 'cloudwatch-logs' (服务器名称,客户端据此名称调用)
- 'command': 'python3' (启动服务器的命令,这里使用 Python 3 解释器)
- 'args': '["/path/to/cloudwatch-logs-mcp/main.py"]' (启动命令的参数,指向 'main.py' 脚本的绝对路径,请替换为实际路径)
注意:
- 请将 '/path/to/cloudwatch-logs-mcp/main.py' 替换为 'main.py' 文件在您本地文件系统中的实际绝对路径。
- 如果需要使用 AWS 访问密钥和密钥进行身份验证,可以将 'AWS_ACCESS_KEY_ID' 和 'AWS_SECRET_ACCESS_KEY' 等环境变量添加到 'env' 字段中,具体请参考仓库 README.md 文档。但更推荐使用默认的 AWS 凭证配置方式。
基本使用方法
- 启动服务器: 配置完成后,启动 MCP 客户端 (如 Claude Desktop),客户端会自动启动并连接到 CloudWatch Logs MCP Server。
- LLM 调用工具: 在 LLM 中,可以使用以下工具与 CloudWatch Logs MCP Server 交互:
- 'list_groups': 列出 CloudWatch 日志组。例如,可以指示 LLM "列出所有以 'api-gateway' 开头的日志组"。
- 'get_logs': 获取指定日志组的日志。例如,可以指示 LLM "获取日志组 'my-app-log-group' 过去 1 小时的日志,并过滤包含 'error' 关键词的条目"。
LLM 将根据用户指令,自动调用相应的工具,并将参数传递给 CloudWatch Logs MCP Server,服务器执行操作后将结果返回给 LLM。
信息
分类
开发者工具