Grey Swan

🚀 Grey Swan Security Arena MongoDB Tool Documentation

This documentation provides a comprehensive guide to the MongoDB tools used in the Grey Swan Security Arena, including installation, usage, and best - practice guidelines.

🚀 Quick Start

This section provides a high - level overview of the installation and startup process.

📦 Installation

Install Dependencies

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

Start the Service

node src/index.ts

💻 Usage Examples

1. Create a MongoDB Instance

Edit the config.json file:

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

2. Initialize the Database Connection

Configure the connection information in src/db/connection.ts.

✨ Features

Core Functions

• Model Management: Create, read, update, and delete model records.
• Thread Management: Handle discussion threads related to AI security challenges.
• Message Management: Store and query conversation content between users and assistants.

Tool List

// Model tool
import { ModelTool } from './tools/mongoModel';
// Thread tool
import { ThreadTool } from './tools/mongoThread';
// Message tool
import { MessageTool } from './tools/mongoMessage';

Basic Usage

Create a Model Record

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

📚 Documentation

Project Structure

src/
├── db/
│   ├── connection.ts         # MongoDB connection configuration
│   ├── controllers/          # Database operation controllers
│   │   ├── modelController.ts
│   │   ├── threadController.ts
│   │   └── messageController.ts
│   └── models/               # Database schema definitions
│       ├── Model.ts
│       ├── Thread.ts
│       └── Message.ts
├── tools/
│   ├── mongoModel.ts         # Model management tool
│   ├── mongoThread.ts        # Thread management tool
│   └── mongoMessage.ts       # Message management tool
└── index.ts                  # Application entry file

Best Practices

1. Naming Conventions: Use English or meaningful Chinese names for variables and functions.
2. Error Handling: Add error catching and logging to each database operation.
3. Data Validation: Conduct strict format checks and validations on input data.

Contribution Guidelines

Any contributions are welcome! Please refer to the project repository for more information.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

🙏 Acknowledgments

Thanks to the MongoDB community for their technical support.