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 社區提供的技術支持。