Grey Swan

🚀 灰天鹅安全竞技场 MongoDB 工具文档

本工具文档围绕灰天鹅安全竞技场的 MongoDB 工具展开，涵盖了该工具的安装、使用方法、功能介绍等内容，能帮助开发者高效地使用 MongoDB 进行模型、线程和消息管理。

🚀 快速开始

要使用灰天鹅安全竞技场 MongoDB 工具，需先完成安装和启动服务的操作。

安装依赖

npm install express mongoose @types/express @types/node cors dotenv

启动服务

node src/index.ts

📦 安装指南

安装依赖

使用以下命令安装所需依赖：

npm install express mongoose @types/express @types/node cors dotenv

启动服务

通过以下命令启动服务：

node src/index.ts

💻 使用示例

基础用法

1. 创建 MongoDB 实例

编辑 config.json 文件来配置 MongoDB 实例信息：

{
"mongoUri": "mongodb://localhost:27017",
"dbName": "securityArenaDB"
}

2. 初始化数据库连接

在 src/db/connection.ts 中配置连接信息。

高级用法

创建模型记录

const modelTool = new ModelTool();
await modelTool.create({
name: "agent-redteam-session1",
provider: "灰天鹅",
version: "1.0",
capabilities: ["redteaming", "prompt-injection"]
});

✨ 主要特性

核心功能

• 模型管理：可创建、读取、更新和删除模型记录。
• 线程管理：能处理与 AI 安全挑战相关的讨论线程。
• 消息管理：可存储和查询用户及助理之间的对话内容。

工具列表

// 模型工具
import { ModelTool } from './tools/mongoModel';
// 线程工具
import { ThreadTool } from './tools/mongoThread';
// 消息工具
import { MessageTool } from './tools/mongoMessage';

📚 详细文档

项目结构

src/
├── db/
│   ├── connection.ts         # MongoDB 连接配置
│   ├── controllers/          # 数据库操作控制器
│   │   ├── modelController.ts
│   │   ├── threadController.ts
│   │   └── messageController.ts
│   └── models/               # 数据库模式定义
│       ├── Model.ts
│       ├── Thread.ts
│       └── Message.ts
├── tools/
│   ├── mongoModel.ts         # 模型管理工具
│   ├── mongoThread.ts        # 线程管理工具
│   └── mongoMessage.ts       # 消息管理工具
└── index.ts                  # 应用入口文件

最佳实践

1. 命名规范：使用英文或有意义的中文命名变量和函数。
2. 错误处理：在每个数据库操作中添加错误捕捉和日志记录。
3. 数据验证：对输入数据进行严格的格式检查和验证。

贡献指南

欢迎任何贡献！请参考项目仓库了解更多信息。

📄 许可证

本项目采用 MIT 许可证，具体条款见 LICENSE 文件。

致谢

感谢 MongoDB 社区提供的技术支持。