🚀 ATLAS MCP 服务器文档

ATLAS 是一个基于模型上下文协议（Model Context Protocol）构建的平台，它拥有强大的工具生态系统，可用于项目管理、任务处理以及知识存储，能有效提升工作效率和数据管理能力。

🚀 快速开始

安装与运行

安装依赖

使用 npm 安装所有必要的依赖：

npm install

启动服务

启动 ATLAS 服务器：

npm run dev

访问 http://localhost:3001 查看文档。

✨ 主要特性

ATLAS 平台提供了丰富的工具，涵盖项目管理、任务处理和知识管理等多个方面，具体如下：

项目管理工具

创建新项目

使用 atlas_create_project 工具创建一个新项目：

npm run create-project

删除项目

删除指定项目的工具：

npm run delete-project

任务处理工具

创建任务

使用 atlas_create_task 创建新的任务：

npm run create-task

更新任务状态

更新任务状态的工具：

npm run update-task-status

知识管理工具

添加知识项

添加新知识项的工具：

npm run add-knowledge

查询知识库

搜索知识库的工具：

npm run search-knowledge

📦 安装指南

安装依赖

使用 npm 安装所有必要的依赖：

npm install

启动服务

启动 ATLAS 服务器：

npm run dev

访问 http://localhost:3001 查看文档。

💻 使用示例

基础用法

创建新项目并添加任务

npm run create-project --name "新项目" --description "项目描述"
npm run create-task --project-id <projectId> --title "新任务"

高级用法

REST API - 获取所有项目

GET /api/projects

REST API - 创建新项目

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

{
  "name": "新项目",
  "description": "项目描述"
}

WebSocket 接口 - 实时更新项目状态

const socket = io('http://localhost:3001');
socket.on('project_updated', (data) => {
  console.log('项目更新:', data);
});

📚 详细文档

项目结构

核心目录结构

atlas-mcp-server/
├── src/                 # 源代码目录
│   ├── services/       # 业务逻辑服务
│   └── routes/         # API 路由
└── package.json        # 包管理文件

关键服务

• src/services/neo4j/driver.ts：Neo4j 数据库连接驱动。
• src/services/neo4j/backupRestoreService.ts：数据库备份与还原服务。

数据模型

实体关系图

Project
├── Task
└── Knowledge

数据存储

ATLAS 使用 Neo4j 作为图形数据库，所有项目、任务和知识项均以节点形式存储，通过关系连接形成复杂的网络结构。

数据访问接口

REST API

• 获取所有项目：

GET /api/projects

• 创建新项目：

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

{
  "name": "新项目",
  "description": "项目描述"
}

WebSocket 接口

实时更新项目状态：

const socket = io('http://localhost:3001');
socket.on('project_updated', (data) => {
  console.log('项目更新:', data);
});

数据持久化

所有数据变更都会自动触发存储操作，确保数据一致性。

数据备份与还原

自动备份说明

⚠️ 重要提示

自动备份功能已被移除。如需备份，请使用手动备份流程。

手动备份步骤

npm run db:backup

此命令执行 scripts/db-backup.ts 脚本，调用 exportDatabase 函数进行数据导出。

数据还原步骤

⚠️ 重要提示

数据还原是破坏性操作，将覆盖现有数据库内容。请谨慎操作！

npm run db:import <备份目录路径>

例如：

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

资源

直接资源

| 属性 | 详情 | |------|------| | 资源地址 | 描述 | | /api/projects | 获取所有项目数据 | | /api/tasks | 获取所有任务信息 | | /api/knowledge | 获取知识库内容 |

关系资源

• 项目与任务：/api/projects/{projectId}/tasks
• 项目与知识项：/api/projects/{projectId}/knowledge

错误处理

常见错误代码

• 400：无效请求参数
• 401：未授权访问
• 500：服务器内部错误

错误日志

所有错误信息会记录到 src/logs/error.log 文件中，便于排查问题。

安全注意事项

认证与授权

所有敏感操作均需通过 JWT 认证，并实施权限控制策略。

数据加密

传输中的数据使用 HTTPS 加密，确保数据安全。

文档扩展

如需查看更多详细信息，请访问 官方文档。

🔧 技术细节

ATLAS 服务器采用了特定的技术架构，以实现高效的数据管理和操作。其核心目录结构清晰，将源代码分为 src/services/ 和 src/routes/ 两个主要部分，分别负责业务逻辑服务和 API 路由。在数据存储方面，使用 Neo4j 图形数据库，通过节点和关系构建复杂的数据网络，确保数据的高效存储和查询。同时，提供了 REST API 和 WebSocket 接口，方便用户进行数据的访问和实时更新。此外，还具备数据持久化、备份与还原等功能，保障数据的安全性和一致性。

📄 许可证

文档中未提及许可证相关信息。

结语

ATLAS 提供了强大的工具集和灵活的 API 接口，助力高效管理项目、任务和知识。通过简单的命令即可完成复杂的数据操作，同时确保数据安全与持久化。无论是开发还是运维，ATLAS 都是您的得力助手！