Splunk MCP 服务器

一个模型上下文协议（MCP）服务器，使AI助手能够安全地搜索、分析和验证Splunk查询，并内置了安全防护措施。

概述

Splunk MCP服务器提供了一个标准化接口，供AI助手（如Claude、GitHub Copilot等）与Splunk Enterprise或Splunk Cloud进行交互。它实现了模型上下文协议，允许AI工具与您的Splunk数据无缝集成。

主要特性

• 智能搜索集成：执行SPL查询并支持多种输出格式（JSON、Markdown、CSV、Summary）
• 内置安全防护措施：自动验证以防止破坏性或资源密集型查询
• 数据保护：自动清理敏感数据（信用卡号、SSN）
• 双传输支持：同时支持SSE（服务器发送事件）和stdio传输
• 丰富的Splunk功能：访问索引、保存的搜索并执行复杂查询
• Docker就绪：容器化部署选项适用于两种实现方式

什么是MCP？

模型上下文协议（MCP）是一个开放标准，使AI助手与外部数据源之间能够无缝集成。它提供了：

• 标准化通信：AI助手与外部工具交互的通用协议
• 安全性：内置的身份验证和授权机制
• 灵活性：支持各种传输机制（stdio、SSE、WebSocket）
• 工具发现：助手可以发现可用工具及其功能

可用实现

本项目提供了两个功能完整的实现：

Python 实现

• 使用FastMCP框架简化开发
• 异步/等待架构以提高性能
• 包含全面的测试套件和交互式工具
• 带有管理脚本的Docker支持

查看Python文档

TypeScript 实现

• 使用TypeScript实现全类型安全
• 构建于官方MCP SDK之上
• 兼容Node.js 18+
• 编译JavaScript输出的生产就绪

查看TypeScript文档

快速开始

选择您偏好的实现方式：

Python 快速开始

cd python
cp .env.example .env
# 使用您的Splunk凭据编辑.env
pip install -e .
python server.py

TypeScript 快速开始

cd typescript
cp .env.example .env
# 使用您的Splunk凭据编辑.env
npm install
npm start

核心能力

可用工具

1. validate_spl - 在执行前验证SPL查询的风险
2. search_oneshot - 执行阻塞搜索并立即返回结果
3. search_export - 高效流式传输大型结果集
4. get_indexes - 列出可用的Splunk索引及其元数据
5. get_saved_searches - 访问保存的搜索配置
6. run_saved_search - 执行预配置的保存搜索
7. get_config - 获取服务器配置

安全特性

服务器包括智能防护措施以保护您的Splunk环境：

• 风险评分：查询被分析并分配风险评分（0-100）
• 可配置阈值：设置自己的风险容忍水平
• 查询阻止：在执行前阻止危险查询
• 性能保护：检测资源密集型模式
• 审计跟踪：所有查询都被验证并记录

支持的客户端

• Claude桌面
• Claude代码
• VS Code Copilot
• 任何兼容MCP的客户端

架构

两种实现遵循相同的架构：

┌─────────────┐     MCP协议    ┌─────────────┐     REST API    ┌──────────┐
│ AI助手      │ ◄─────────────────► │ MCP服务器  │ ◄─────────────► │  Splunk  │
│  (客户端)   │    stdio/SSE/WS     │ (此仓库)   │    端口8089   │ 实例     │
└─────────────┘                     └─────────────┘                 └──────────┘

安全注意事项

• 凭证：安全存储在.env文件中（绝不要提交到版本控制）
• 网络：生产部署时使用SSL/TLS
• 权限：对Splunk账户应用最小权限原则
• 验证：所有查询在执行前都会被验证
• 清理：输出中的敏感数据会被自动屏蔽

项目结构

splunk-mcp-server/
├── README.md           # 此文件
├── LICENSE             # MIT许可证
├── python/             # Python实现
│   ├── README.md       # 详细的Python文档
│   ├── server.py       # 主服务器实现
│   ├── guardrails.py   # 查询验证逻辑
│   └── tests/          # 测试套件和工具
└── typescript/         # TypeScript实现
    ├── README.md       # 详细的TypeScript文档
    ├── server.ts       # 主服务器实现
    ├── guardrails.ts   # 查询验证逻辑
    └── tests/          # 测试脚本

贡献

我们欢迎贡献！请参阅实现特定的README文件获取开发设置和指南。

许可证

本项目采用MIT许可证 - 详情见LICENSE文件。

支持

• 问题：GitHub问题
• 讨论：GitHub讨论
• MCP文档：modelcontextprotocol.io
• Splunk REST API：Splunk文档

---

选择您偏好的实现方式以开始详细设置说明、配置选项和使用示例。