README
🚀 微软Sentinel MCP服务器指南
本指南详细介绍了微软Sentinel MCP服务器的安装、配置、开发、认证等方面的内容,帮助您快速上手并使用该服务器。
🚀 快速开始
在Claude Desktop或其他MCP兼容客户端中安装
使用提供的PowerShell安装脚本来设置MCP服务器以适用于Claude Desktop或类似环境:
# 从存储库根目录运行
.\install.ps1
该脚本将执行以下操作:
- 检查Python的安装情况
- 创建虚拟环境并安装依赖项
- 执行安装后配置步骤
- 生成适用于Claude Desktop的配置文件
- 将配置复制到剪贴板
运行脚本后,可以直接将配置粘贴到您的MCP客户端(如Claude Desktop、Cursor等)中。该脚本会为Claude兼容的MCP服务器生成配置。
📦 安装指南
高级安装选项
手动环境设置
如果您更倾向于手动设置环境:
- 配置环境变量 复制提供的模板并填写您的Azure凭证:
cp .env.example .env
# 编辑.env文件并设置:
# AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET, AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP, AZURE_WORKSPACE_NAME, AZURE_WORKSPACE_ID
- 安装依赖项(使用uv)
uv venv
uv pip install -e .
- 替代服务器运行选项
- 使用MCP CLI:
mcp run wrapper.py
- **开发与热重载**:
mcp dev wrapper.py
- **SSE模式(针对IDE)**:
python wrapper.py --sse
检查工具UI
当使用mcp dev wrapper.py运行时,MCP检查工具UI将在http://127.0.0.1:6274可用。
📚 详细文档
开发指南
- 资源:将Python文件添加到
resources/目录,并实现一个register_resources(mcp)函数。 - 工具:将Python文件添加到
tools/目录,并实现一个register_tools(mcp)函数。工具必须遵循在docs/tool-architecture-and-implementation-requirements.md中定义的结构。 - 提示:将提示模板添加到
prompts/目录,用于LLM驱动的工作流程。
所有位于resources/、tools/和prompts/目录中的组件将在服务器启动时自动发现并注册。无需手动导入。
认证与环境变量
MCP Server支持由Azure Python SDK的DefaultAzureCredential支持的任何认证方法。
使用服务主体身份验证而非Azure CLI
在Azure中设置一个应用程序注册,并授予以下角色:
Log Analytics ReaderMicrosoft Sentinel Reader
如果您愿意,也可以授予应用程序注册以下Microsoft Graph权限:
User.Read.AllGroup.Read.All
然后,在您的.env文件或MCP Server配置中使用以下环境变量:
AZURE_TENANT_IDAZURE_CLIENT_IDAZURE_CLIENT_SECRETAZURE_SUBSCRIPTION_IDAZURE_RESOURCE_GROUPAZURE_WORKSPACE_NAMEAZURE_WORKSPACE_ID
查看.env.example获取模板。
使用Azure CLI身份验证
az login
如果您使用Azure CLI身份验证,则可以从您的配置中省略AZURE_CLIENT_SECRET和AZURE_CLIENT_SECRET。
错误排除与支持
如果在安装或配置过程中遇到问题,请参考项目文档或联系支持团队。您也可以通过社区论坛或其他资源寻求帮助。
以上是Microsoft Sentinel MCP Server的完整指南,涵盖了从安装到开发的所有内容。
Scan to contact