🚀 ATLAS MCP Server Documentation

ATLAS is a platform built on the Model Context Protocol (MCP). It offers a powerful ecosystem of tools for project management, task processing, and knowledge storage.

🚀 Quick Start

Installation and Running

Install Dependencies

Use npm to install all necessary dependencies:

npm install

Start the Service

Start the ATLAS server:

npm run dev

Access http://localhost:3001 to view the documentation.

✨ Features

Project Management Tools

Create a New Project

Use the atlas_create_project tool to create a new project:

npm run create-project

Delete a Project

A tool to delete a specified project:

npm run delete-project

Task Processing Tools

Create a Task

Use atlas_create_task to create a new task:

npm run create-task

Update Task Status

A tool to update the status of a task:

npm run update-task-status

Knowledge Management Tools

Add a Knowledge Item

A tool to add a new knowledge item:

npm run add-knowledge

Query the Knowledge Base

A tool to search the knowledge base:

npm run search-knowledge

🔧 Technical Details

Core Directory Structure

atlas-mcp-server/
├── src/                 # Source code directory
│   ├── services/       # Business logic services
│   └── routes/         # API routes
└── package.json        # Package management file

Key Services

• src/services/neo4j/driver.ts: Neo4j database connection driver.
• src/services/neo4j/backupRestoreService.ts: Database backup and restore service.

Data Model

Entity Relationship Diagram

Project
├── Task
└── Knowledge

Data Storage

ATLAS uses Neo4j as a graph database. All projects, tasks, and knowledge items are stored as nodes and connected by relationships to form a complex network structure.

Data Access Interfaces

REST API

Get All Projects

GET /api/projects

Create a New Project

POST /api/projects
Content-Type: application/json

{
  "name": "New Project",
  "description": "Project description"
}

WebSocket Interface

Real-time update of project status:

const socket = io('http://localhost:3001');
socket.on('project_updated', (data) => {
  console.log('Project updated:', data);
});

Data Persistence

All data changes will automatically trigger storage operations to ensure data consistency.

Data Backup and Restoration

Automatic Backup Note

Note: The automatic backup function has been removed. Please use the manual backup process if you need to back up data.

Manual Backup Steps

npm run db:backup

This command executes the scripts/db-backup.ts script and calls the exportDatabase function to export data.

Data Restoration Steps

Restoration Warning

Data restoration is a destructive operation that will overwrite the existing database content. Please operate with caution!

Manual Restoration Process

npm run db:import <Backup directory path>

For example:

npm run db:import ./atlas-backups/atlas-backup-20250326120000

Resources

Direct Resources

Relational Resources

• Projects and tasks: /api/projects/{projectId}/tasks
• Projects and knowledge items: /api/projects/{projectId}/knowledge

💻 Usage Examples

Create a New Project and Add a Task

npm run create-project --name "New Project" --description "Project description"
npm run create-task --project-id <projectId> --title "New Task"

Error Handling

Common Error Codes

• 400: Invalid request parameters
• 401: Unauthorized access
• 500: Internal server error

Error Logs

All error information is recorded in the src/logs/error.log file for easy troubleshooting.

Security Considerations

Authentication and Authorization

All sensitive operations require JWT authentication, and a permission control strategy is implemented.

Data Encryption

Data in transit is encrypted using HTTPS to ensure data security.

Documentation Extension

For more detailed information, please visit Official Documentation.

Conclusion

ATLAS provides a powerful toolset and flexible API interfaces to help you efficiently manage projects, tasks, and knowledge. Complex data operations can be completed with simple commands while ensuring data security and persistence. Whether you are a developer or an operator, ATLAS is your reliable assistant!