🚀 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/{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 都是您的得力助手！