README
🚀 AIM Guard MCP
🛡️ AIM Guard MCP 是一款基于AI的安全防护工具,为模型上下文协议(MCP)提供安全分析和防护指导。它能在AI代理与各类MCP及外部服务交互时,提供安全指南、内容分析和警示说明,有效保护AI代理的安全。
🚀 快速开始
AIM Guard MCP是一个模型上下文协议(MCP)服务器,提供基于人工智能的安全分析和安全指导工具。该服务器通过在与各种MCP和外部服务交互时提供安全指南、内容分析和警示说明,帮助保护AI代理。
✨ 主要特性
- 🛡️ AI安全卫士:在MCP交互前,为AI代理提供上下文安全说明和预防措施。
- 🔍 文本防护分析:使用AIM Intelligence API分析文本内容,检测有害或不当内容。
- 🔒 安全提示增强:在用户提示中添加安全说明,使AI交互更安全。
- ⚡ 快速轻量:采用TypeScript和Zod验证构建。
- 🔧 易于集成:可与任何兼容MCP的AI助手配合使用。
- 🔗 API集成:连接AIM Intelligence API进行高级内容分析。
📦 安装指南
NPX(推荐)
npx aim-guard-mcp
全局安装
npm install -g aim-guard-mcp
aim-guard-mcp
本地安装
npm install aim-guard-mcp
💻 使用示例
作为MCP服务器
添加到您的MCP客户端配置中:
{
"servers": {
"aim-guard": {
"type": "stdio",
"command": "npx",
"args": ["aim-guard-mcp"]
}
}
}
测试工具
测试AI安全卫士
# 获取数据库操作的安全说明
{
"name": "ai-safety-guard",
"arguments": {
"mcp_type": "database",
"operation_type": "query",
"sensitivity_level": "confidential"
}
}
测试文本防护
# 分析文本中的有害内容
{
"name": "aim-text-guard",
"arguments": {
"text": "This is a sample text to analyze for safety."
}
}
测试安全提示增强
# 用安全说明增强用户提示
{
"name": "aim-security-prompt-tool",
"arguments": {
"user_prompt": "Please help me with this task",
"security_level": "strict"
}
}
可用工具
1. ai-safety-guard
在AI代理与其他MCP交互前,提供上下文安全说明和预防措施。
{
"name": "ai-safety-guard",
"arguments": {
"mcp_type": "email|slack|database|file|web|general", // 调用的MCP类型
"operation_type": "read|write|execute|delete|send|query", // 执行的操作
"sensitivity_level": "public|internal|confidential|restricted" // 数据敏感级别
}
}
特性:
- 基于MCP类型的上下文感知安全指南。
- 特定操作的警告和预防措施。
- 敏感级别协议和限制。
- 安全MCP交互的综合清单。
- 危险标志检测和中止建议。
2. aim-text-guard
使用AIM Intelligence API分析文本内容,检测有害或不当内容。
{
"name": "aim-text-guard",
"arguments": {
"text": "Text content to analyze for harmful content"
}
}
特性:
- 实时内容分析。
- 有害内容检测。
- 以JSON格式提供详细分析结果。
- 带有信息性消息的错误处理。
- 分析请求的时间戳跟踪。
3. aim-security-prompt-tool
在用户提示中添加安全说明,使AI交互更安全。
{
"name": "aim-security-prompt-tool",
"arguments": {
"user_prompt": "Original user prompt to enhance",
"security_level": "basic|standard|strict" // 可选,默认为 'standard'
}
}
特性:
- 多级安全增强(基本、标准、严格)。
- 全面的威胁分析说明。
- 社会工程防护指南。
- 安全策略合规性检查。
- 清理和验证要求。
🔧 技术细节
🛡️ AI代理保护
- MCP交互安全:针对不同MCP类型提供上下文指南。
- 操作验证:针对读/写/执行操作提供特定预防措施。
- 数据敏感性处理:基于数据分类级别制定协议。
🔍 内容分析
- 实时威胁检测:分析内容中的有害模式。
- API驱动分析:先进的AI驱动内容安全评估。
- 综合报告:详细的安全分析结果。
🔒 提示安全
- 安全增强提示:在用户提示中添加保护说明。
- 可配置安全级别:从基本到严格的安全协议。
- 威胁预防:在AI交互中采取主动安全措施。
🚧 开发
# 克隆仓库
git clone https://github.com/AIM-Intelligence/AIM-MCP.git
cd AIM-MCP
# 安装依赖
pnpm install
# 构建项目
pnpm run build
# 以开发模式运行
pnpm run dev
# 运行测试
pnpm test
🚀 部署
本项目使用自动化CI/CD管道,可无缝部署到NPM。
自动部署
当您推送到main分支时,GitHub Actions将自动执行以下操作:
- 构建和测试:编译TypeScript并运行测试。
- 版本检查:比较当前版本与已发布版本。
- 发布到NPM:如果版本有更改,自动发布。
- 创建发布:生成带有版本标签的GitHub发布。
手动版本管理
# 升级补丁版本 (1.0.0 -> 1.0.1)
pnpm run release:patch
# 升级次版本 (1.0.0 -> 1.1.0)
pnpm run release:minor
# 升级主版本 (1.0.0 -> 2.0.0)
pnpm run release:major
设置NPM令牌
要启用自动部署,请将您的NPM令牌添加到GitHub Secrets:
- 访问 npmjs.com 创建一个自动化令牌。
- 在您的GitHub仓库中,转到设置 > 机密和变量 > 操作。
- 添加一个名为
NPM_TOKEN的新机密,并输入您的NPM令牌值。
部署工作流
graph LR
A[Push to main] --> B[GitHub Actions]
B --> C[Build & Test]
C --> D[Version Check]
D --> E{Version Changed?}
E -->|Yes| F[Publish to NPM]
E -->|No| G[Skip Deployment]
F --> H[Create GitHub Release]
F --> I[Create Git Tag]
🤝 贡献代码
- 分叉仓库。
- 创建您的功能分支 (
git checkout -b feature/amazing-feature)。 - 提交您的更改 (
git commit -m 'Add some amazing feature')。 - 推送到该分支 (
git push origin feature/amazing-feature)。 - 打开一个拉取请求。
📄 许可证
本项目采用ISC许可证 - 详情请参阅 LICENSE 文件。
📞 支持
- 📧 邮箱:support@aim-intelligence.com
- 🐛 问题反馈:GitHub Issues
- 📖 文档:GitHub Wiki
由 AIM Intelligence 用心打造 ❤️
Scan to join WeChat group