Compare commits

..

No commits in common. "main" and "v1.0.20" have entirely different histories.

43 changed files with 300 additions and 740 deletions

View File

@ -23,9 +23,6 @@ TEMPLATES_USE=en
# Default is false.
ENABLE_GUI=false
# WebGUI port
WEB_PORT=3000
# ============================
# Prompt Customization
# ============================

View File

@ -2,21 +2,6 @@
# Changelog
## [1.0.21]
### Added
- Added support for ListRoots protocol and optimized DATA_DIR configuration method (99baa0f)
- Added WEB_PORT environment variable to customize WebGUI port number (8771a5b)
### Changed
- Updated documentation to reflect new configuration options (99baa0f, 8771a5b)
### Fixed
- Fix #56: Added configurable WebGUI port to avoid port conflicts (8771a5b)
## [1.0.20]
### Added

124
README.md
View File

@ -42,7 +42,7 @@ Shrimp Task Manager guides Agents through structured workflows for systematic pr
- **Task Memory Function**: Automatically backup task history, providing long-term memory and reference capabilities
- **Research Mode**: Systematic technical research capabilities with guided workflows for exploring technologies, best practices, and solution comparisons
- **Project Rules Initialization**: Define project standards and rules to maintain consistency across large projects
- **<a id="web-gui"></a>Web GUI**: Provides an optional web-based graphical user interface for task management. Enable by setting `ENABLE_GUI=true` in your `.env` file. When enabled, a `WebGUI.md` file containing the access address will be created in your `DATA_DIR`. You can customize the web port by setting `WEB_PORT` (if not specified, an available port will be automatically selected).
- **<a id="web-gui"></a>Web GUI**: Provides an optional web-based graphical user interface for task management. Enable by setting `ENABLE_GUI=true` in your `.env` file. When enabled, a `WebGUI.md` file containing the access address will be created in your `DATA_DIR`.
## 🧭 <a id="usage-guide"></a>Usage Guide
@ -215,52 +215,36 @@ Shrimp Task Manager can be used with any client that supports the Model Context
Shrimp Task Manager offers two configuration methods: global configuration and project-specific configuration.
#### ListRoots Protocol Support
Shrimp Task Manager now supports the **ListRoots protocol**, which enables automatic project isolation and flexible path configuration:
- **If your client supports ListRoots** (e.g., Cursor IDE):
- **Absolute path mode**: Create a project folder within the specified DATA_DIR, enabling you to use a global mcp.json configuration while Shrimp automatically isolates projects
- **Relative path mode**: Create the DATA_DIR within your project root directory for project-specific data storage
- **If your client doesn't support ListRoots**:
- DATA_DIR maintains the legacy behavior (absolute paths recommended)
- We recommend asking your client vendor to support the ListRoots protocol for enhanced functionality
#### Global Configuration
1. Open the Cursor IDE global configuration file (usually located at `~/.cursor/mcp.json`)
2. Add the following configuration in the `mcpServers` section:
**Option A: Absolute Path (Project Isolation Mode)**
```json
{
"mcpServers": {
"shrimp-task-manager": {
"command": "node",
"args": ["/path/to/mcp-shrimp-task-manager/dist/index.js"],
"args": ["/mcp-shrimp-task-manager/dist/index.js"],
"env": {
"DATA_DIR": "/Users/username/ShrimpData", // Absolute path - creates project folders automatically
"DATA_DIR": "/path/to/project/data", // 必須使用絕對路徑
"TEMPLATES_USE": "en",
"ENABLE_GUI": "false"
}
}
}
}
```
**Option B: NPX with Absolute Path**
```json
or
{
"mcpServers": {
"shrimp-task-manager": {
"command": "npx",
"args": ["-y", "mcp-shrimp-task-manager"],
"env": {
"DATA_DIR": "/Users/username/ShrimpData", // Absolute path - creates project folders automatically
"DATA_DIR": "/mcp-shrimp-task-manager/data",
"TEMPLATES_USE": "en",
"ENABLE_GUI": "false"
}
@ -269,21 +253,15 @@ Shrimp Task Manager now supports the **ListRoots protocol**, which enables autom
}
```
> ⚠️ Please replace `/path/to/mcp-shrimp-task-manager` and `/Users/username/ShrimpData` with your actual paths.
>
> 💡 **Absolute Path Advantage**: With ListRoots support, Shrimp automatically creates separate folders for each project (e.g., `/Users/username/ShrimpData/my-project/`, `/Users/username/ShrimpData/another-project/`), enabling perfect project isolation with a single global configuration.
>
> 💡 **Optional:** You can add `"WEB_PORT": "3000"` to the `env` section to specify a custom port for the web GUI. If not specified, an available port will be automatically selected.
> ⚠️ Please replace `/mcp-shrimp-task-manager` with your actual path.
#### Project-Specific Configuration
You can also set up dedicated configurations for each project. This method allows using relative paths for project-contained data storage:
You can also set up dedicated configurations for each project to use independent data directories for different projects:
1. Create a `.cursor` directory in the project root
2. Create an `mcp.json` file in this directory with the following content:
**Option A: Relative Path (Project-Contained Mode)**
```json
{
"mcpServers": {
@ -291,25 +269,24 @@ You can also set up dedicated configurations for each project. This method allow
"command": "node",
"args": ["/path/to/mcp-shrimp-task-manager/dist/index.js"],
"env": {
"DATA_DIR": ".shrimp", // Relative path - creates folder within project root
"DATA_DIR": "/path/to/project/data", // Must use absolute path
"TEMPLATES_USE": "en",
"ENABLE_GUI": "false"
}
}
}
}
```
**Option B: NPX with Relative Path**
```json
or
{
"mcpServers": {
"shrimp-task-manager": {
"command": "npx",
"args": ["-y", "mcp-shrimp-task-manager"],
"env": {
"DATA_DIR": "shrimp-data", // Relative path - creates folder within project root
"DATA_DIR": "/path/to/project/data", // Must use absolute path
"TEMPLATES_USE": "en",
"ENABLE_GUI": "false"
}
@ -318,86 +295,17 @@ You can also set up dedicated configurations for each project. This method allow
}
```
**Option C: Absolute Path (Alternative)**
```json
{
"mcpServers": {
"shrimp-task-manager": {
"command": "npx",
"args": ["-y", "mcp-shrimp-task-manager"],
"env": {
"DATA_DIR": "/Users/username/ShrimpData", // Absolute path with project isolation
"TEMPLATES_USE": "en",
"ENABLE_GUI": "false"
}
}
}
}
```
> ⚠️ Please replace `/path/to/mcp-shrimp-task-manager` with your actual path.
>
> 💡 **Relative Path Advantage**: Data is stored within your project directory (e.g., `./shrimp-data/`), making it easy to include or exclude from version control as needed.
>
> 💡 **Optional:** You can add `"WEB_PORT": "3000"` to the `env` section to specify a custom port for the web GUI. If not specified, an available port will be automatically selected.
### ⚠️ Important Configuration Notes
The **DATA_DIR parameter** is the directory where Shrimp Task Manager stores task data, conversation logs, and other information. The new implementation supports both absolute and relative paths with intelligent behavior based on your client's capabilities.
The **DATA_DIR parameter** is the directory where Shrimp Task Manager stores task data, conversation logs, and other information. Setting this parameter correctly is crucial for the normal operation of the system. This parameter must use an **absolute path**; using a relative path may cause the system to incorrectly locate the data directory, resulting in data loss or function failure.
#### 🚀 With ListRoots Protocol Support (Recommended)
If your client supports the **ListRoots protocol** (like Cursor IDE), Shrimp Task Manager automatically detects your project root and provides enhanced functionality:
**Absolute Path Mode (Project Isolation):**
- Configuration: `"DATA_DIR": "/Users/username/ShrimpData"`
- Behavior: Creates `{DATA_DIR}/{project-name}/` automatically
- Example: For project "my-app" → `/Users/username/ShrimpData/my-app/`
- **Advantage**: Use one global configuration for all projects with perfect isolation
**Relative Path Mode (Project-Contained):**
- Configuration: `"DATA_DIR": ".shrimp"` or `"DATA_DIR": "shrimp-data"`
- Behavior: Creates `{project-root}/{DATA_DIR}/` within your project
- Example: For DATA_DIR "shrimp-data" → `./shrimp-data/`
- **Advantage**: Data stays with your project, easy to include/exclude from version control
#### ⚠️ Without ListRoots Protocol Support (Legacy Mode)
If your client **doesn't support ListRoots**, the system falls back to legacy behavior:
- **Absolute paths are strongly recommended** to avoid path resolution issues
- Relative paths may cause inconsistent behavior across different environments
- Consider requesting ListRoots support from your client vendor for enhanced functionality
> **Legacy Warning**: Without ListRoots support, using relative paths may cause:
> **Warning**: Using relative paths may cause the following issues:
>
> - Data files not found, causing system initialization failure
> - Task status loss or inability to save correctly
> - Inconsistent application behavior across different environments
> - System crashes or failure to start
#### 💡 Choosing the Right Configuration
**Use Absolute Path (Global) when:**
- You want to manage multiple projects with one configuration
- You prefer centralized data storage
- You want automatic project isolation
**Use Relative Path (Project-Specific) when:**
- You want data to stay within the project directory
- You work on projects in different environments
- You need fine control over what gets included in version control
**Use Legacy Mode when:**
- Your client doesn't support ListRoots protocol
- You need compatibility with older client versions
### 🔧 Environment Variable Configuration
Shrimp Task Manager supports customizing prompt behavior through environment variables, allowing you to fine-tune AI assistant responses without modifying code. You can set these variables in the configuration or through an `.env` file:
@ -428,9 +336,7 @@ There are two customization methods:
Additionally, there are other system configuration variables:
- **DATA_DIR**: Specifies the directory where task data is stored
- **TEMPLATES_USE**: Specifies the template set to use for prompts. Defaults to `en`. Currently available options are `en` and `zh`. To use custom templates, copy the `src/prompts/templates_en` directory to the location specified by `DATA_DIR`, rename the copied directory (e.g., to `my_templates`), and set `TEMPLATES_USE` to the new directory name (e.g., `my_templates`)
- **ENABLE_GUI**: Enables or disables the web-based graphical user interface. Set to `true` to enable, `false` to disable (default)
- **WEB_PORT**: Specifies the port for the web GUI. If not specified, an available port will be automatically selected. Only takes effect when `ENABLE_GUI` is set to `true`
- **TEMPLATES_USE**: Specifies the template set to use for prompts. Defaults to `en`. Currently available options are `en` and `zh`. To use custom templates, copy the `src/prompts/templates_en` directory to the location specified by `DATA_DIR`, rename the copied directory (e.g., to `my_templates`), and set `TEMPLATES_USE` to the new directory name (e.g., `my_templates`).
For detailed instructions on customizing prompts, including supported parameters and examples, see the [Prompt Customization Guide](docs/en/prompt-customization.md).

View File

@ -2,21 +2,6 @@
# 更新日誌
## [1.0.21]
### 新增
- 新增對 ListRoots 協議的支援,優化 DATA_DIR 配置方式 (99baa0f)
- 新增 WEB_PORT 環境變數以自訂 WebGUI 埠號 (8771a5b)
### 變更
- 更新相關文檔說明以反映新的配置選項 (99baa0f, 8771a5b)
### 修復
- 修復 #56:新增可配置的 WebGUI 埠號以避免埠號衝突 (8771a5b)
## [1.0.20]
### 新增

View File

@ -39,7 +39,7 @@
- **思維鏈過程**:通過步驟化的推理系統性地分析複雜問題
- **研究模式**:系統性技術研究功能,提供引導式工作流程來探索技術、最佳實踐和解決方案比較
- **專案規範初始化**:定義專案標準和規則,維持大型專案的一致性
- **<a id="網頁圖形介面"></a>網頁圖形介面**:提供選用的網頁圖形化使用者介面來管理任務。透過在您的 `.env` 檔案中設定 `ENABLE_GUI=true` 來啟用。啟用後,將會在您的 `DATA_DIR` 中建立一個包含存取網址的 `WebGUI.md` 檔案。您可以透過設定 `WEB_PORT` 來自訂網頁埠號(若未指定,系統將自動選擇可用的埠號)。
- **<a id="網頁圖形介面"></a>網頁圖形介面**:提供選用的網頁圖形化使用者介面來管理任務。透過在您的 `.env` 檔案中設定 `ENABLE_GUI=true` 來啟用。啟用後,將會在您的 `DATA_DIR` 中建立一個包含存取網址的 `WebGUI.md` 檔案。
## 🧭 <a id="使用指南"></a>使用指南
@ -212,53 +212,36 @@ npm run build
蝦米任務管理器提供兩種配置方式:全局配置和專案特定配置。
#### ListRoots 協議支援
蝦米任務管理器現在支援 **ListRoots 協議**,提供自動專案隔離和靈活的路徑配置功能:
- **如果您的客戶端支援 ListRoots** (例如 Cursor IDE)
- **絕對路徑模式**:在指定的 DATA_DIR 中建立專案資料夾,讓您可以使用全域 mcp.json 配置Shrimp 會自動隔離專案
- **相對路徑模式**:在專案根目錄中建立 DATA_DIR 來存放 Shrimp 資料
- **如果您的客戶端不支援 ListRoots**
- DATA_DIR 保持舊版邏輯(建議使用絕對路徑)
- 建議向您的客戶端廠商要求支援 ListRoots 協議以獲得增強功能
#### 全局配置
1. 開啟 Cursor IDE 的全局設定檔案(通常位於 `~/.cursor/mcp.json`
2. 在 `mcpServers` 區段中添加以下配置:
**選項 A絕對路徑專案隔離模式**
```json
{
"mcpServers": {
"shrimp-task-manager": {
"command": "node",
"args": ["/path/to/mcp-shrimp-task-manager/dist/index.js"],
"args": ["/mcp-shrimp-task-manager/dist/index.js"],
"env": {
"DATA_DIR": "/Users/username/ShrimpData", // 絕對路徑 - 自動建立專案資料夾
"TEMPLATES_USE": "zh",
"DATA_DIR": "/mcp-shrimp-task-manager/data",
"TEMPLATES_USE": "en",
"ENABLE_GUI": "false"
}
}
}
}
```
**選項 BNPX 配合絕對路徑**
or
```json
{
"mcpServers": {
"shrimp-task-manager": {
"command": "npx",
"args": ["-y", "mcp-shrimp-task-manager"],
"env": {
"DATA_DIR": "/Users/username/ShrimpData", // 絕對路徑 - 自動建立專案資料夾
"TEMPLATES_USE": "zh",
"DATA_DIR": "/mcp-shrimp-task-manager/data",
"TEMPLATES_USE": "en",
"ENABLE_GUI": "false"
}
}
@ -266,21 +249,15 @@ npm run build
}
```
> ⚠️ 請將 `/path/to/mcp-shrimp-task-manager``/Users/username/ShrimpData` 替換為您的實際路徑。
>
> 💡 **絕對路徑優勢**:透過 ListRoots 支援Shrimp 會自動為每個專案建立獨立資料夾(例如 `/Users/username/ShrimpData/my-project/``/Users/username/ShrimpData/another-project/`),實現完美的專案隔離,只需要一個全域配置。
>
> 💡 **可選設定:** 您可以在 `env` 區段中添加 `"WEB_PORT": "3000"` 來指定網頁 GUI 的自訂埠號。若未指定,系統將自動選擇可用的埠號。
> ⚠️ 請將 `/mcp-shrimp-task-manager` 替換為您的實際路徑。
#### 專案特定配置
您也可以為每個專案設定專屬配置。此方法允許使用相對路徑進行專案內數據存放
您也可以為每個專案設定專屬配置,以便針對不同專案使用獨立的數據目錄:
1. 在專案根目錄創建 `.cursor` 目錄
2. 在該目錄下創建 `mcp.json` 文件,內容如下:
**選項 A相對路徑專案內存放模式**
```json
{
"mcpServers": {
@ -288,26 +265,24 @@ npm run build
"command": "node",
"args": ["/path/to/mcp-shrimp-task-manager/dist/index.js"],
"env": {
"DATA_DIR": ".shrimp", // 相對路徑 - 在專案根目錄建立資料夾
"TEMPLATES_USE": "zh",
"DATA_DIR": "/path/to/project/data", // 必須使用絕對路徑
"TEMPLATES_USE": "en",
"ENABLE_GUI": "false"
}
}
}
}
```
**選項 BNPX 配合相對路徑**
or
```json
{
"mcpServers": {
"shrimp-task-manager": {
"command": "npx",
"args": ["-y", "mcp-shrimp-task-manager"],
"env": {
"DATA_DIR": "shrimp-data", // 相對路徑 - 在專案根目錄建立資料夾
"TEMPLATES_USE": "zh",
"DATA_DIR": "/path/to/project/data", // 必須使用絕對路徑
"TEMPLATES_USE": "en",
"ENABLE_GUI": "false"
}
}
@ -315,86 +290,17 @@ npm run build
}
```
**選項 C絕對路徑替代方案**
```json
{
"mcpServers": {
"shrimp-task-manager": {
"command": "npx",
"args": ["-y", "mcp-shrimp-task-manager"],
"env": {
"DATA_DIR": "/Users/username/ShrimpData", // 絕對路徑配合專案隔離
"TEMPLATES_USE": "zh",
"ENABLE_GUI": "false"
}
}
}
}
```
> ⚠️ 請將 `/path/to/mcp-shrimp-task-manager` 替換為您的實際路徑。
>
> 💡 **相對路徑優勢**:資料存放在專案目錄內(例如 `./shrimp-data/`),方便根據需要選擇是否納入版本控制。
>
> 💡 **可選設定:** 您可以在 `env` 區段中添加 `"WEB_PORT": "3000"` 來指定網頁 GUI 的自訂埠號。若未指定,系統將自動選擇可用的埠號。
### ⚠️ 重要配置說明
**DATA_DIR 參數**是蝦米任務管理器存儲任務數據、對話記錄等資訊的目錄。新的實作支援絕對路徑和相對路徑,並根據您的客戶端功能提供智慧化行為
**DATA_DIR 參數**是蝦米任務管理器存儲任務數據、對話記錄等信息的目錄,正確設置此參數對於系統的正常運行至關重要。此參數必須使用**絕對路徑**,使用相對路徑可能導致系統無法正確定位數據目錄,造成數據丟失或功能失效。
#### 🚀 支援 ListRoots 協議(建議)
如果您的客戶端支援 **ListRoots 協議**(如 Cursor IDE蝦米任務管理器會自動偵測您的專案根目錄並提供增強功能
**絕對路徑模式(專案隔離):**
- 配置:`"DATA_DIR": "/Users/username/ShrimpData"`
- 行為:自動建立 `{DATA_DIR}/{專案名稱}/`
- 範例:對於專案 "my-app" → `/Users/username/ShrimpData/my-app/`
- **優勢**:使用一個全域配置管理所有專案,完美隔離
**相對路徑模式(專案內存放):**
- 配置:`"DATA_DIR": ".shrimp"``"DATA_DIR": "shrimp-data"`
- 行為:在專案內建立 `{專案根目錄}/{DATA_DIR}/`
- 範例:對於 DATA_DIR "shrimp-data" → `./shrimp-data/`
- **優勢**:資料與專案一起存放,方便選擇是否納入版本控制
#### ⚠️ 不支援 ListRoots 協議(舊版模式)
如果您的客戶端**不支援 ListRoots**,系統會回退到舊版行為:
- **強烈建議使用絕對路徑**以避免路徑解析問題
- 相對路徑可能在不同環境下導致行為不一致
- 建議向您的客戶端廠商要求 ListRoots 支援以獲得增強功能
> **舊版警告**:沒有 ListRoots 支援時,使用相對路徑可能導致:
> **警告**:使用相對路徑可能導致以下問題:
>
> - 數據檔案找不到,導致系統初始化失敗
> - 任務狀態丟失或無法正確保存
> - 應用程式在不同環境下行為不一致
> - 系統崩潰或無法啟動
#### 💡 選擇合適的配置
**使用絕對路徑(全域)當:**
- 您想用一個配置管理多個專案
- 您偏好集中式資料存放
- 您想要自動專案隔離
**使用相對路徑(專案特定)當:**
- 您想讓資料存放在專案目錄內
- 您在不同環境中工作
- 您需要精確控制版本控制的內容
**使用舊版模式當:**
- 您的客戶端不支援 ListRoots 協議
- 您需要與較舊的客戶端版本相容
### 🔧 環境變數配置
蝦米任務管理器支援透過環境變數自定義提示詞行為,讓您無需修改程式碼即可微調 AI 助手的回應。您可以在配置中或透過 `.env` 文件設置這些變數:
@ -425,9 +331,7 @@ npm run build
此外,還有其他系統配置變數:
- **DATA_DIR**:指定任務數據存儲的目錄
- **TEMPLATES_USE**:指定提示詞使用的模板集。預設為 `en`。目前可用的選項有 `en``zh`。若要使用自定義模板,請將 `src/prompts/templates_en` 目錄複製到 `DATA_DIR` 指定的位置,重新命名複製的目錄(例如,`my_templates`),並將 `TEMPLATES_USE` 設置為新的目錄名稱(例如,`my_templates`
- **ENABLE_GUI**:啟用或停用網頁圖形化使用者介面。設定為 `true` 以啟用,`false` 以停用(預設)
- **WEB_PORT**:指定網頁 GUI 的埠號。若未指定,系統將自動選擇可用的埠號。僅在 `ENABLE_GUI` 設定為 `true` 時生效
- **TEMPLATES_USE**:指定提示詞使用的模板集。預設為 `en`。目前可用的選項有 `en``zh`。若要使用自定義模板,請將 `src/prompts/templates_en` 目錄複製到 `DATA_DIR` 指定的位置,重新命名複製的目錄(例如,`my_templates`),並將 `TEMPLATES_USE` 設置為新的目錄名稱(例如,`my_templates`)。
有關自定義提示詞的詳細說明,包括支援的參數和範例,請參閱[提示詞自定義指南](prompt-customization.md)。

View File

@ -1,6 +1,6 @@
{
"name": "mcp-shrimp-task-manager",
"version": "1.0.21",
"version": "1.0.20",
"description": "Shrimp Task Manager is a task tool built for AI Agents, emphasizing chain-of-thought, reflection, and style consistency. It converts natural language into structured dev tasks with dependency tracking and iterative refinement, enabling agent-like developer behavior in reasoning AI systems",
"main": "dist/index.js",
"type": "module",

View File

@ -7,10 +7,13 @@ import {
CallToolRequest,
CallToolRequestSchema,
ListToolsRequestSchema,
InitializedNotificationSchema,
} from "@modelcontextprotocol/sdk/types.js";
import { setGlobalServer } from "./utils/paths.js";
import { createWebServer } from "./web/webServer.js";
import express, { Request, Response, NextFunction } from "express";
import getPort from "get-port";
import path from "path";
import fs from "fs";
import fsPromises from "fs/promises";
import { fileURLToPath } from "url";
// 導入所有工具函數和 schema
import {
@ -51,8 +54,131 @@ import {
async function main() {
try {
const ENABLE_GUI = process.env.ENABLE_GUI === "true";
let webServerInstance: Awaited<ReturnType<typeof createWebServer>> | null =
null;
if (ENABLE_GUI) {
// 創建 Express 應用
const app = express();
// 儲存 SSE 客戶端的列表
let sseClients: Response[] = [];
// 發送 SSE 事件的輔助函數
function sendSseUpdate() {
sseClients.forEach((client) => {
// 檢查客戶端是否仍然連接
if (!client.writableEnded) {
client.write(
`event: update\ndata: ${JSON.stringify({
timestamp: Date.now(),
})}\n\n`
);
}
});
// 清理已斷開的客戶端 (可選,但建議)
sseClients = sseClients.filter((client) => !client.writableEnded);
}
// 設置靜態文件目錄
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const publicPath = path.join(__dirname, "public");
const DATA_DIR = process.env.DATA_DIR || path.join(__dirname, "data");
const TASKS_FILE_PATH = path.join(DATA_DIR, "tasks.json"); // 提取檔案路徑
app.use(express.static(publicPath));
// 設置 API 路由
app.get("/api/tasks", async (req: Request, res: Response) => {
try {
// 使用 fsPromises 保持異步讀取
const tasksData = await fsPromises.readFile(TASKS_FILE_PATH, "utf-8");
res.json(JSON.parse(tasksData));
} catch (error) {
// 確保檔案不存在時返回空任務列表
if ((error as NodeJS.ErrnoException).code === "ENOENT") {
res.json({ tasks: [] });
} else {
res.status(500).json({ error: "Failed to read tasks data" });
}
}
});
// 新增SSE 端點
app.get("/api/tasks/stream", (req: Request, res: Response) => {
res.writeHead(200, {
"Content-Type": "text/event-stream",
"Cache-Control": "no-cache",
Connection: "keep-alive",
// 可選: CORS 頭,如果前端和後端不在同一個 origin
// "Access-Control-Allow-Origin": "*",
});
// 發送一個初始事件或保持連接
res.write("data: connected\n\n");
// 將客戶端添加到列表
sseClients.push(res);
// 當客戶端斷開連接時,將其從列表中移除
req.on("close", () => {
sseClients = sseClients.filter((client) => client !== res);
});
});
// 獲取可用埠
const port = await getPort();
// 啟動 HTTP 伺服器
const httpServer = app.listen(port, () => {
// 在伺服器啟動後開始監聽檔案變化
try {
// 檢查檔案是否存在,如果不存在則不監聽 (避免 watch 報錯)
if (fs.existsSync(TASKS_FILE_PATH)) {
fs.watch(TASKS_FILE_PATH, (eventType, filename) => {
if (
filename &&
(eventType === "change" || eventType === "rename")
) {
// 稍微延遲發送,以防短時間內多次觸發 (例如編輯器保存)
// debounce sendSseUpdate if needed
sendSseUpdate();
}
});
}
} catch (watchError) {}
});
// 將 URL 寫入 WebGUI.md
try {
// 讀取 TEMPLATES_USE 環境變數並轉換為語言代碼
const templatesUse = process.env.TEMPLATES_USE || "en";
const getLanguageFromTemplate = (template: string): string => {
if (template === "zh") return "zh-TW";
if (template === "en") return "en";
// 自訂範本預設使用英文
return "en";
};
const language = getLanguageFromTemplate(templatesUse);
const websiteUrl = `[Task Manager UI](http://localhost:${port}?lang=${language})`;
const websiteFilePath = path.join(DATA_DIR, "WebGUI.md");
await fsPromises.writeFile(websiteFilePath, websiteUrl, "utf-8");
} catch (error) {}
// 設置進程終止事件處理 (確保移除 watcher)
const shutdownHandler = async () => {
// 關閉所有 SSE 連接
sseClients.forEach((client) => client.end());
sseClients = [];
// 關閉 HTTP 伺服器
await new Promise<void>((resolve) => httpServer.close(() => resolve()));
process.exit(0);
};
process.on("SIGINT", shutdownHandler);
process.on("SIGTERM", shutdownHandler);
}
// 創建MCP服務器
const server = new Server(
@ -63,128 +189,112 @@ async function main() {
{
capabilities: {
tools: {},
logging: {},
},
}
);
// 設置全局 server 實例
setGlobalServer(server);
// 監聽 initialized 通知來啟動 web 服務器
if (ENABLE_GUI) {
server.setNotificationHandler(InitializedNotificationSchema, async () => {
try {
webServerInstance = await createWebServer();
await webServerInstance.startServer();
} catch (error) {}
});
}
server.setRequestHandler(ListToolsRequestSchema, async () => {
return {
tools: [
{
name: "plan_task",
description: await loadPromptFromTemplate(
"toolsDescription/planTask.md"
),
description: loadPromptFromTemplate("toolsDescription/planTask.md"),
inputSchema: zodToJsonSchema(planTaskSchema),
},
{
name: "analyze_task",
description: await loadPromptFromTemplate(
description: loadPromptFromTemplate(
"toolsDescription/analyzeTask.md"
),
inputSchema: zodToJsonSchema(analyzeTaskSchema),
},
{
name: "reflect_task",
description: await loadPromptFromTemplate(
description: loadPromptFromTemplate(
"toolsDescription/reflectTask.md"
),
inputSchema: zodToJsonSchema(reflectTaskSchema),
},
{
name: "split_tasks",
description: await loadPromptFromTemplate(
description: loadPromptFromTemplate(
"toolsDescription/splitTasks.md"
),
inputSchema: zodToJsonSchema(splitTasksRawSchema),
},
{
name: "list_tasks",
description: await loadPromptFromTemplate(
description: loadPromptFromTemplate(
"toolsDescription/listTasks.md"
),
inputSchema: zodToJsonSchema(listTasksSchema),
},
{
name: "execute_task",
description: await loadPromptFromTemplate(
description: loadPromptFromTemplate(
"toolsDescription/executeTask.md"
),
inputSchema: zodToJsonSchema(executeTaskSchema),
},
{
name: "verify_task",
description: await loadPromptFromTemplate(
description: loadPromptFromTemplate(
"toolsDescription/verifyTask.md"
),
inputSchema: zodToJsonSchema(verifyTaskSchema),
},
{
name: "delete_task",
description: await loadPromptFromTemplate(
description: loadPromptFromTemplate(
"toolsDescription/deleteTask.md"
),
inputSchema: zodToJsonSchema(deleteTaskSchema),
},
{
name: "clear_all_tasks",
description: await loadPromptFromTemplate(
description: loadPromptFromTemplate(
"toolsDescription/clearAllTasks.md"
),
inputSchema: zodToJsonSchema(clearAllTasksSchema),
},
{
name: "update_task",
description: await loadPromptFromTemplate(
description: loadPromptFromTemplate(
"toolsDescription/updateTask.md"
),
inputSchema: zodToJsonSchema(updateTaskContentSchema),
},
{
name: "query_task",
description: await loadPromptFromTemplate(
description: loadPromptFromTemplate(
"toolsDescription/queryTask.md"
),
inputSchema: zodToJsonSchema(queryTaskSchema),
},
{
name: "get_task_detail",
description: await loadPromptFromTemplate(
description: loadPromptFromTemplate(
"toolsDescription/getTaskDetail.md"
),
inputSchema: zodToJsonSchema(getTaskDetailSchema),
},
{
name: "process_thought",
description: await loadPromptFromTemplate(
description: loadPromptFromTemplate(
"toolsDescription/processThought.md"
),
inputSchema: zodToJsonSchema(processThoughtSchema),
},
{
name: "init_project_rules",
description: await loadPromptFromTemplate(
description: loadPromptFromTemplate(
"toolsDescription/initProjectRules.md"
),
inputSchema: zodToJsonSchema(initProjectRulesSchema),
},
{
name: "research_mode",
description: await loadPromptFromTemplate(
description: loadPromptFromTemplate(
"toolsDescription/researchMode.md"
),
inputSchema: zodToJsonSchema(researchModeSchema),

View File

@ -13,25 +13,21 @@ import { v4 as uuidv4 } from "uuid";
import { fileURLToPath } from "url";
import { exec } from "child_process";
import { promisify } from "util";
import { getDataDir, getTasksFilePath, getMemoryDir } from "../utils/paths.js";
// 確保獲取專案資料夾路徑
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const PROJECT_ROOT = path.resolve(__dirname, "../..");
// 數據文件路徑(改為異步獲取)
// const DATA_DIR = getDataDir();
// const TASKS_FILE = getTasksFilePath();
// 數據文件路徑
const DATA_DIR = process.env.DATA_DIR || path.join(PROJECT_ROOT, "data");
const TASKS_FILE = path.join(DATA_DIR, "tasks.json");
// 將exec轉換為Promise形式
const execPromise = promisify(exec);
// 確保數據目錄存在
async function ensureDataDir() {
const DATA_DIR = await getDataDir();
const TASKS_FILE = await getTasksFilePath();
try {
await fs.access(DATA_DIR);
} catch (error) {
@ -48,7 +44,6 @@ async function ensureDataDir() {
// 讀取所有任務
async function readTasks(): Promise<Task[]> {
await ensureDataDir();
const TASKS_FILE = await getTasksFilePath();
const data = await fs.readFile(TASKS_FILE, "utf-8");
const tasks = JSON.parse(data).tasks;
@ -64,7 +59,6 @@ async function readTasks(): Promise<Task[]> {
// 寫入所有任務
async function writeTasks(tasks: Task[]): Promise<void> {
await ensureDataDir();
const TASKS_FILE = await getTasksFilePath();
await fs.writeFile(TASKS_FILE, JSON.stringify({ tasks }, null, 2));
}
@ -703,7 +697,7 @@ export async function clearAllTasks(): Promise<{
const backupFileName = `tasks_memory_${timestamp}.json`;
// 確保 memory 目錄存在
const MEMORY_DIR = await getMemoryDir();
const MEMORY_DIR = path.join(DATA_DIR, "memory");
try {
await fs.access(MEMORY_DIR);
} catch (error) {
@ -757,7 +751,7 @@ export async function searchTasksWithCommand(
let memoryTasks: Task[] = [];
// 搜尋記憶資料夾中的任務
const MEMORY_DIR = await getMemoryDir();
const MEMORY_DIR = path.join(DATA_DIR, "memory");
try {
// 確保記憶資料夾存在

View File

@ -23,14 +23,10 @@ export interface AnalyzeTaskPromptParams {
* @param params prompt
* @returns prompt
*/
export async function getAnalyzeTaskPrompt(
params: AnalyzeTaskPromptParams
): Promise<string> {
const indexTemplate = await loadPromptFromTemplate("analyzeTask/index.md");
export function getAnalyzeTaskPrompt(params: AnalyzeTaskPromptParams): string {
const indexTemplate = loadPromptFromTemplate("analyzeTask/index.md");
const iterationTemplate = await loadPromptFromTemplate(
"analyzeTask/iteration.md"
);
const iterationTemplate = loadPromptFromTemplate("analyzeTask/iteration.md");
let iterationPrompt = "";
if (params.previousAnalysis) {

View File

@ -25,24 +25,20 @@ export interface ClearAllTasksPromptParams {
* @param params prompt
* @returns prompt
*/
export async function getClearAllTasksPrompt(
export function getClearAllTasksPrompt(
params: ClearAllTasksPromptParams
): Promise<string> {
): string {
const { confirm, success, message, backupFile, isEmpty } = params;
// 處理未確認的情況
if (confirm === false) {
const cancelTemplate = await loadPromptFromTemplate(
"clearAllTasks/cancel.md"
);
const cancelTemplate = loadPromptFromTemplate("clearAllTasks/cancel.md");
return generatePrompt(cancelTemplate, {});
}
// 處理無任務需要清除的情況
if (isEmpty) {
const emptyTemplate = await loadPromptFromTemplate(
"clearAllTasks/empty.md"
);
const emptyTemplate = loadPromptFromTemplate("clearAllTasks/empty.md");
return generatePrompt(emptyTemplate, {});
}
@ -51,15 +47,12 @@ export async function getClearAllTasksPrompt(
// 使用模板生成 backupInfo
const backupInfo = backupFile
? generatePrompt(
await loadPromptFromTemplate("clearAllTasks/backupInfo.md"),
{
backupFile,
}
)
? generatePrompt(loadPromptFromTemplate("clearAllTasks/backupInfo.md"), {
backupFile,
})
: "";
const indexTemplate = await loadPromptFromTemplate("clearAllTasks/index.md");
const indexTemplate = loadPromptFromTemplate("clearAllTasks/index.md");
const prompt = generatePrompt(indexTemplate, {
responseTitle,
message,

View File

@ -23,12 +23,12 @@ export interface CompleteTaskPromptParams {
* @param params prompt
* @returns prompt
*/
export async function getCompleteTaskPrompt(
export function getCompleteTaskPrompt(
params: CompleteTaskPromptParams
): Promise<string> {
): string {
const { task, completionTime } = params;
const indexTemplate = await loadPromptFromTemplate("completeTask/index.md");
const indexTemplate = loadPromptFromTemplate("completeTask/index.md");
// 開始構建基本 prompt
let prompt = generatePrompt(indexTemplate, {

View File

@ -26,16 +26,12 @@ export interface DeleteTaskPromptParams {
* @param params prompt
* @returns prompt
*/
export async function getDeleteTaskPrompt(
params: DeleteTaskPromptParams
): Promise<string> {
export function getDeleteTaskPrompt(params: DeleteTaskPromptParams): string {
const { taskId, task, success, message, isTaskCompleted } = params;
// 處理任務不存在的情況
if (!task) {
const notFoundTemplate = await loadPromptFromTemplate(
"deleteTask/notFound.md"
);
const notFoundTemplate = loadPromptFromTemplate("deleteTask/notFound.md");
return generatePrompt(notFoundTemplate, {
taskId,
});
@ -43,9 +39,7 @@ export async function getDeleteTaskPrompt(
// 處理任務已完成的情況
if (isTaskCompleted) {
const completedTemplate = await loadPromptFromTemplate(
"deleteTask/completed.md"
);
const completedTemplate = loadPromptFromTemplate("deleteTask/completed.md");
return generatePrompt(completedTemplate, {
taskId: task.id,
taskName: task.name,
@ -54,7 +48,7 @@ export async function getDeleteTaskPrompt(
// 處理刪除成功或失敗的情況
const responseTitle = success ? "Success" : "Failure";
const indexTemplate = await loadPromptFromTemplate("deleteTask/index.md");
const indexTemplate = loadPromptFromTemplate("deleteTask/index.md");
const prompt = generatePrompt(indexTemplate, {
responseTitle,
message,

View File

@ -55,13 +55,11 @@ function getComplexityStyle(level: string): string {
* @param params prompt
* @returns prompt
*/
export async function getExecuteTaskPrompt(
params: ExecuteTaskPromptParams
): Promise<string> {
export function getExecuteTaskPrompt(params: ExecuteTaskPromptParams): string {
const { task, complexityAssessment, relatedFilesSummary, dependencyTasks } =
params;
const notesTemplate = await loadPromptFromTemplate("executeTask/notes.md");
const notesTemplate = loadPromptFromTemplate("executeTask/notes.md");
let notesPrompt = "";
if (task.notes) {
notesPrompt = generatePrompt(notesTemplate, {
@ -69,7 +67,7 @@ export async function getExecuteTaskPrompt(
});
}
const implementationGuideTemplate = await loadPromptFromTemplate(
const implementationGuideTemplate = loadPromptFromTemplate(
"executeTask/implementationGuide.md"
);
let implementationGuidePrompt = "";
@ -79,7 +77,7 @@ export async function getExecuteTaskPrompt(
});
}
const verificationCriteriaTemplate = await loadPromptFromTemplate(
const verificationCriteriaTemplate = loadPromptFromTemplate(
"executeTask/verificationCriteria.md"
);
let verificationCriteriaPrompt = "";
@ -89,7 +87,7 @@ export async function getExecuteTaskPrompt(
});
}
const analysisResultTemplate = await loadPromptFromTemplate(
const analysisResultTemplate = loadPromptFromTemplate(
"executeTask/analysisResult.md"
);
let analysisResultPrompt = "";
@ -99,7 +97,7 @@ export async function getExecuteTaskPrompt(
});
}
const dependencyTasksTemplate = await loadPromptFromTemplate(
const dependencyTasksTemplate = loadPromptFromTemplate(
"executeTask/dependencyTasks.md"
);
let dependencyTasksPrompt = "";
@ -121,7 +119,7 @@ export async function getExecuteTaskPrompt(
}
}
const relatedFilesSummaryTemplate = await loadPromptFromTemplate(
const relatedFilesSummaryTemplate = loadPromptFromTemplate(
"executeTask/relatedFilesSummary.md"
);
let relatedFilesSummaryPrompt = "";
@ -129,7 +127,7 @@ export async function getExecuteTaskPrompt(
relatedFilesSummary: relatedFilesSummary || "當前任務沒有關聯的文件。",
});
const complexityTemplate = await loadPromptFromTemplate(
const complexityTemplate = loadPromptFromTemplate(
"executeTask/complexity.md"
);
let complexityPrompt = "";
@ -153,7 +151,7 @@ export async function getExecuteTaskPrompt(
});
}
const indexTemplate = await loadPromptFromTemplate("executeTask/index.md");
const indexTemplate = loadPromptFromTemplate("executeTask/index.md");
let prompt = generatePrompt(indexTemplate, {
name: task.name,
id: task.id,

View File

@ -24,16 +24,14 @@ export interface GetTaskDetailPromptParams {
* @param params prompt
* @returns prompt
*/
export async function getGetTaskDetailPrompt(
export function getGetTaskDetailPrompt(
params: GetTaskDetailPromptParams
): Promise<string> {
): string {
const { taskId, task, error } = params;
// 如果有錯誤,顯示錯誤訊息
if (error) {
const errorTemplate = await loadPromptFromTemplate(
"getTaskDetail/error.md"
);
const errorTemplate = loadPromptFromTemplate("getTaskDetail/error.md");
return generatePrompt(errorTemplate, {
errorMessage: error,
});
@ -41,7 +39,7 @@ export async function getGetTaskDetailPrompt(
// 如果找不到任務,顯示找不到任務的訊息
if (!task) {
const notFoundTemplate = await loadPromptFromTemplate(
const notFoundTemplate = loadPromptFromTemplate(
"getTaskDetail/notFound.md"
);
return generatePrompt(notFoundTemplate, {
@ -51,9 +49,7 @@ export async function getGetTaskDetailPrompt(
let notesPrompt = "";
if (task.notes) {
const notesTemplate = await loadPromptFromTemplate(
"getTaskDetail/notes.md"
);
const notesTemplate = loadPromptFromTemplate("getTaskDetail/notes.md");
notesPrompt = generatePrompt(notesTemplate, {
notes: task.notes,
});
@ -61,7 +57,7 @@ export async function getGetTaskDetailPrompt(
let dependenciesPrompt = "";
if (task.dependencies && task.dependencies.length > 0) {
const dependenciesTemplate = await loadPromptFromTemplate(
const dependenciesTemplate = loadPromptFromTemplate(
"getTaskDetail/dependencies.md"
);
dependenciesPrompt = generatePrompt(dependenciesTemplate, {
@ -73,7 +69,7 @@ export async function getGetTaskDetailPrompt(
let implementationGuidePrompt = "";
if (task.implementationGuide) {
const implementationGuideTemplate = await loadPromptFromTemplate(
const implementationGuideTemplate = loadPromptFromTemplate(
"getTaskDetail/implementationGuide.md"
);
implementationGuidePrompt = generatePrompt(implementationGuideTemplate, {
@ -83,7 +79,7 @@ export async function getGetTaskDetailPrompt(
let verificationCriteriaPrompt = "";
if (task.verificationCriteria) {
const verificationCriteriaTemplate = await loadPromptFromTemplate(
const verificationCriteriaTemplate = loadPromptFromTemplate(
"getTaskDetail/verificationCriteria.md"
);
verificationCriteriaPrompt = generatePrompt(verificationCriteriaTemplate, {
@ -93,7 +89,7 @@ export async function getGetTaskDetailPrompt(
let relatedFilesPrompt = "";
if (task.relatedFiles && task.relatedFiles.length > 0) {
const relatedFilesTemplate = await loadPromptFromTemplate(
const relatedFilesTemplate = loadPromptFromTemplate(
"getTaskDetail/relatedFiles.md"
);
relatedFilesPrompt = generatePrompt(relatedFilesTemplate, {
@ -110,7 +106,7 @@ export async function getGetTaskDetailPrompt(
let complatedSummaryPrompt = "";
if (task.completedAt) {
const complatedSummaryTemplate = await loadPromptFromTemplate(
const complatedSummaryTemplate = loadPromptFromTemplate(
"getTaskDetail/complatedSummary.md"
);
complatedSummaryPrompt = generatePrompt(complatedSummaryTemplate, {
@ -119,7 +115,7 @@ export async function getGetTaskDetailPrompt(
});
}
const indexTemplate = await loadPromptFromTemplate("getTaskDetail/index.md");
const indexTemplate = loadPromptFromTemplate("getTaskDetail/index.md");
// 開始構建基本 prompt
let prompt = generatePrompt(indexTemplate, {

View File

@ -16,12 +16,10 @@ export interface InitProjectRulesPromptParams {
* @param params prompt
* @returns prompt
*/
export async function getInitProjectRulesPrompt(
export function getInitProjectRulesPrompt(
params?: InitProjectRulesPromptParams
): Promise<string> {
const indexTemplate = await loadPromptFromTemplate(
"initProjectRules/index.md"
);
): string {
const indexTemplate = loadPromptFromTemplate("initProjectRules/index.md");
// 載入可能的自定義 prompt (通過環境變數覆蓋或追加)
return loadPrompt(indexTemplate, "INIT_PROJECT_RULES");

View File

@ -24,16 +24,12 @@ export interface ListTasksPromptParams {
* @param params prompt
* @returns prompt
*/
export async function getListTasksPrompt(
params: ListTasksPromptParams
): Promise<string> {
export function getListTasksPrompt(params: ListTasksPromptParams): string {
const { status, tasks, allTasks } = params;
// 如果沒有任務,顯示通知
if (allTasks.length === 0) {
const notFoundTemplate = await loadPromptFromTemplate(
"listTasks/notFound.md"
);
const notFoundTemplate = loadPromptFromTemplate("listTasks/notFound.md");
const statusText = status === "all" ? "任何" : `任何 ${status}`;
return generatePrompt(notFoundTemplate, {
statusText: statusText,
@ -62,9 +58,7 @@ export async function getListTasksPrompt(
}
let taskDetails = "";
let taskDetailsTemplate = await loadPromptFromTemplate(
"listTasks/taskDetails.md"
);
let taskDetailsTemplate = loadPromptFromTemplate("listTasks/taskDetails.md");
// 添加每個狀態下的詳細任務
for (const statusType of Object.values(TaskStatus)) {
const tasksWithStatus = tasks[statusType] || [];
@ -94,7 +88,7 @@ export async function getListTasksPrompt(
}
}
const indexTemplate = await loadPromptFromTemplate("listTasks/index.md");
const indexTemplate = loadPromptFromTemplate("listTasks/index.md");
let prompt = generatePrompt(indexTemplate, {
statusCount: statusCounts,
taskDetailsTemplate: taskDetails,

View File

@ -27,9 +27,7 @@ export interface PlanTaskPromptParams {
* @param params prompt
* @returns prompt
*/
export async function getPlanTaskPrompt(
params: PlanTaskPromptParams
): Promise<string> {
export function getPlanTaskPrompt(params: PlanTaskPromptParams): string {
let tasksContent = "";
if (
params.existingTasksReference &&
@ -103,7 +101,7 @@ export async function getPlanTaskPrompt(
});
}
const tasksTemplate = await loadPromptFromTemplate("planTask/tasks.md");
const tasksTemplate = loadPromptFromTemplate("planTask/tasks.md");
tasksContent = generatePrompt(tasksTemplate, {
completedTasks: completeTasksContent,
unfinishedTasks: unfinishedTasksContent,
@ -113,11 +111,11 @@ export async function getPlanTaskPrompt(
let thoughtTemplate = "";
if (process.env.ENABLE_THOUGHT_CHAIN !== "false") {
thoughtTemplate = await loadPromptFromTemplate("planTask/hasThought.md");
thoughtTemplate = loadPromptFromTemplate("planTask/hasThought.md");
} else {
thoughtTemplate = await loadPromptFromTemplate("planTask/noThought.md");
thoughtTemplate = loadPromptFromTemplate("planTask/noThought.md");
}
const indexTemplate = await loadPromptFromTemplate("planTask/index.md");
const indexTemplate = loadPromptFromTemplate("planTask/index.md");
let prompt = generatePrompt(indexTemplate, {
description: params.description,
requirements: params.requirements || "No requirements",

View File

@ -15,21 +15,19 @@ export interface ProcessThoughtPromptParams {
assumptions_challenged: string[];
}
export async function getProcessThoughtPrompt(
export function getProcessThoughtPrompt(
param: ProcessThoughtPromptParams
): Promise<string> {
): string {
let nextThoughtNeeded = "";
if (param.nextThoughtNeeded) {
nextThoughtNeeded = await loadPromptFromTemplate(
"processThought/moreThought.md"
);
nextThoughtNeeded = loadPromptFromTemplate("processThought/moreThought.md");
} else {
nextThoughtNeeded = await loadPromptFromTemplate(
nextThoughtNeeded = loadPromptFromTemplate(
"processThought/complatedThought.md"
);
}
const indexTemplate = await loadPromptFromTemplate("processThought/index.md");
const indexTemplate = loadPromptFromTemplate("processThought/index.md");
const prompt = generatePrompt(indexTemplate, {
thought: param.thought,

View File

@ -28,21 +28,17 @@ export interface QueryTaskPromptParams {
* @param params prompt
* @returns prompt
*/
export async function getQueryTaskPrompt(
params: QueryTaskPromptParams
): Promise<string> {
export function getQueryTaskPrompt(params: QueryTaskPromptParams): string {
const { query, isId, tasks, totalTasks, page, pageSize, totalPages } = params;
if (tasks.length === 0) {
const notFoundTemplate = await loadPromptFromTemplate(
"queryTask/notFound.md"
);
const notFoundTemplate = loadPromptFromTemplate("queryTask/notFound.md");
return generatePrompt(notFoundTemplate, {
query,
});
}
const taskDetailsTemplate = await loadPromptFromTemplate(
const taskDetailsTemplate = loadPromptFromTemplate(
"queryTask/taskDetails.md"
);
let tasksContent = "";
@ -59,7 +55,7 @@ export async function getQueryTaskPrompt(
});
}
const indexTemplate = await loadPromptFromTemplate("queryTask/index.md");
const indexTemplate = loadPromptFromTemplate("queryTask/index.md");
const prompt = generatePrompt(indexTemplate, {
tasksContent,
page,

View File

@ -22,10 +22,8 @@ export interface ReflectTaskPromptParams {
* @param params prompt
* @returns prompt
*/
export async function getReflectTaskPrompt(
params: ReflectTaskPromptParams
): Promise<string> {
const indexTemplate = await loadPromptFromTemplate("reflectTask/index.md");
export function getReflectTaskPrompt(params: ReflectTaskPromptParams): string {
const indexTemplate = loadPromptFromTemplate("reflectTask/index.md");
const prompt = generatePrompt(indexTemplate, {
summary: params.summary,
analysis: params.analysis,

View File

@ -25,13 +25,13 @@ export interface ResearchModePromptParams {
* @param params prompt
* @returns prompt
*/
export async function getResearchModePrompt(
export function getResearchModePrompt(
params: ResearchModePromptParams
): Promise<string> {
): string {
// 處理之前的研究狀態
let previousStateContent = "";
if (params.previousState && params.previousState.trim() !== "") {
const previousStateTemplate = await loadPromptFromTemplate(
const previousStateTemplate = loadPromptFromTemplate(
"researchMode/previousState.md"
);
previousStateContent = generatePrompt(previousStateTemplate, {
@ -42,7 +42,7 @@ export async function getResearchModePrompt(
}
// 載入主要模板
const indexTemplate = await loadPromptFromTemplate("researchMode/index.md");
const indexTemplate = loadPromptFromTemplate("researchMode/index.md");
let prompt = generatePrompt(indexTemplate, {
topic: params.topic,
previousStateContent: previousStateContent,

View File

@ -24,10 +24,8 @@ export interface SplitTasksPromptParams {
* @param params prompt
* @returns prompt
*/
export async function getSplitTasksPrompt(
params: SplitTasksPromptParams
): Promise<string> {
const taskDetailsTemplate = await loadPromptFromTemplate(
export function getSplitTasksPrompt(params: SplitTasksPromptParams): string {
const taskDetailsTemplate = loadPromptFromTemplate(
"splitTasks/taskDetails.md"
);
@ -74,7 +72,7 @@ export async function getSplitTasksPrompt(
})
.join("\n");
const indexTemplate = await loadPromptFromTemplate("splitTasks/index.md");
const indexTemplate = loadPromptFromTemplate("splitTasks/index.md");
const prompt = generatePrompt(indexTemplate, {
updateMode: params.updateMode,
tasksContent,

View File

@ -28,9 +28,9 @@ export interface UpdateTaskContentPromptParams {
* @param params prompt
* @returns prompt
*/
export async function getUpdateTaskContentPrompt(
export function getUpdateTaskContentPrompt(
params: UpdateTaskContentPromptParams
): Promise<string> {
): string {
const {
taskId,
task,
@ -43,7 +43,7 @@ export async function getUpdateTaskContentPrompt(
// 處理任務不存在的情況
if (!task) {
const notFoundTemplate = await loadPromptFromTemplate(
const notFoundTemplate = loadPromptFromTemplate(
"updateTaskContent/notFound.md"
);
return generatePrompt(notFoundTemplate, {
@ -53,7 +53,7 @@ export async function getUpdateTaskContentPrompt(
// 處理驗證錯誤的情況
if (validationError) {
const validationTemplate = await loadPromptFromTemplate(
const validationTemplate = loadPromptFromTemplate(
"updateTaskContent/validation.md"
);
return generatePrompt(validationTemplate, {
@ -63,7 +63,7 @@ export async function getUpdateTaskContentPrompt(
// 處理空更新的情況
if (emptyUpdate) {
const emptyUpdateTemplate = await loadPromptFromTemplate(
const emptyUpdateTemplate = loadPromptFromTemplate(
"updateTaskContent/emptyUpdate.md"
);
return generatePrompt(emptyUpdateTemplate, {});
@ -75,14 +75,14 @@ export async function getUpdateTaskContentPrompt(
// 更新成功且有更新後的任務詳情
if (success && updatedTask) {
const successTemplate = await loadPromptFromTemplate(
const successTemplate = loadPromptFromTemplate(
"updateTaskContent/success.md"
);
// 編合相關文件信息
let filesContent = "";
if (updatedTask.relatedFiles && updatedTask.relatedFiles.length > 0) {
const fileDetailsTemplate = await loadPromptFromTemplate(
const fileDetailsTemplate = loadPromptFromTemplate(
"updateTaskContent/fileDetails.md"
);
@ -130,9 +130,7 @@ export async function getUpdateTaskContentPrompt(
});
}
const indexTemplate = await loadPromptFromTemplate(
"updateTaskContent/index.md"
);
const indexTemplate = loadPromptFromTemplate("updateTaskContent/index.md");
const prompt = generatePrompt(indexTemplate, {
responseTitle,
message: content,

View File

@ -44,12 +44,10 @@ function extractSummary(
* @param params prompt
* @returns prompt
*/
export async function getVerifyTaskPrompt(
params: VerifyTaskPromptParams
): Promise<string> {
export function getVerifyTaskPrompt(params: VerifyTaskPromptParams): string {
const { task, score, summary } = params;
if (score < 80) {
const noPassTemplate = await loadPromptFromTemplate("verifyTask/noPass.md");
const noPassTemplate = loadPromptFromTemplate("verifyTask/noPass.md");
const prompt = generatePrompt(noPassTemplate, {
name: task.name,
id: task.id,
@ -57,7 +55,7 @@ export async function getVerifyTaskPrompt(
});
return prompt;
}
const indexTemplate = await loadPromptFromTemplate("verifyTask/index.md");
const indexTemplate = loadPromptFromTemplate("verifyTask/index.md");
const prompt = generatePrompt(indexTemplate, {
name: task.name,
id: task.id,

View File

@ -6,7 +6,6 @@
import fs from "fs";
import path from "path";
import { fileURLToPath } from "url";
import { getDataDir } from "../utils/paths.js";
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
@ -80,22 +79,22 @@ export function generatePrompt(
* @returns
* @throws Error
*/
export async function loadPromptFromTemplate(
templatePath: string
): Promise<string> {
export function loadPromptFromTemplate(templatePath: string): string {
const templateSetName = process.env.TEMPLATES_USE || "en";
const dataDir = await getDataDir();
const dataDir = process.env.DATA_DIR;
const builtInTemplatesBaseDir = __dirname;
let finalPath = "";
const checkedPaths: string[] = []; // 用於更詳細的錯誤報告
// 1. 檢查 DATA_DIR 中的自定義路徑
// path.resolve 可以處理 templateSetName 是絕對路徑的情況
const customFilePath = path.resolve(dataDir, templateSetName, templatePath);
checkedPaths.push(`Custom: ${customFilePath}`);
if (fs.existsSync(customFilePath)) {
finalPath = customFilePath;
if (dataDir) {
// path.resolve 可以處理 templateSetName 是絕對路徑的情況
const customFilePath = path.resolve(dataDir, templateSetName, templatePath);
checkedPaths.push(`Custom: ${customFilePath}`);
if (fs.existsSync(customFilePath)) {
finalPath = customFilePath;
}
}
// 2. 如果未找到自定義路徑,檢查特定的內建模板目錄

View File

@ -11,7 +11,7 @@ export const initProjectRulesSchema = z.object({});
export async function initProjectRules() {
try {
// 從生成器獲取提示詞
const promptContent = await getInitProjectRulesPrompt();
const promptContent = getInitProjectRulesPrompt();
// 返回成功響應
return {

View File

@ -2,7 +2,6 @@ import { z } from "zod";
import path from "path";
import { fileURLToPath } from "url";
import { getResearchModePrompt } from "../../prompts/index.js";
import { getMemoryDir } from "../../utils/paths.js";
// 研究模式工具
export const researchModeSchema = z.object({
@ -41,10 +40,11 @@ export async function researchMode({
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const PROJECT_ROOT = path.resolve(__dirname, "../../..");
const MEMORY_DIR = await getMemoryDir();
const DATA_DIR = process.env.DATA_DIR || path.join(PROJECT_ROOT, "data");
const MEMORY_DIR = path.join(DATA_DIR, "memory");
// 使用prompt生成器獲取最終prompt
const prompt = await getResearchModePrompt({
const prompt = getResearchModePrompt({
topic,
previousState,
currentState,

View File

@ -32,7 +32,7 @@ export async function analyzeTask({
previousAnalysis,
}: z.infer<typeof analyzeTaskSchema>) {
// 使用prompt生成器獲取最終prompt
const prompt = await getAnalyzeTaskPrompt({
const prompt = getAnalyzeTaskPrompt({
summary,
initialConcept,
previousAnalysis,

View File

@ -25,7 +25,7 @@ export async function clearAllTasks({
content: [
{
type: "text" as const,
text: await getClearAllTasksPrompt({ confirm: false }),
text: getClearAllTasksPrompt({ confirm: false }),
},
],
};
@ -38,7 +38,7 @@ export async function clearAllTasks({
content: [
{
type: "text" as const,
text: await getClearAllTasksPrompt({ isEmpty: true }),
text: getClearAllTasksPrompt({ isEmpty: true }),
},
],
};
@ -51,7 +51,7 @@ export async function clearAllTasks({
content: [
{
type: "text" as const,
text: await getClearAllTasksPrompt({
text: getClearAllTasksPrompt({
success: result.success,
message: result.message,
backupFile: result.backupFile,

View File

@ -25,7 +25,7 @@ export async function deleteTask({ taskId }: z.infer<typeof deleteTaskSchema>) {
content: [
{
type: "text" as const,
text: await getDeleteTaskPrompt({ taskId }),
text: getDeleteTaskPrompt({ taskId }),
},
],
isError: true,
@ -37,11 +37,7 @@ export async function deleteTask({ taskId }: z.infer<typeof deleteTaskSchema>) {
content: [
{
type: "text" as const,
text: await getDeleteTaskPrompt({
taskId,
task,
isTaskCompleted: true,
}),
text: getDeleteTaskPrompt({ taskId, task, isTaskCompleted: true }),
},
],
isError: true,
@ -54,7 +50,7 @@ export async function deleteTask({ taskId }: z.infer<typeof deleteTaskSchema>) {
content: [
{
type: "text" as const,
text: await getDeleteTaskPrompt({
text: getDeleteTaskPrompt({
taskId,
task,
success: result.success,

View File

@ -126,7 +126,7 @@ export async function executeTask({
}
// 使用prompt生成器獲取最終prompt
const prompt = await getExecuteTaskPrompt({
const prompt = getExecuteTaskPrompt({
task,
complexityAssessment,
relatedFilesSummary,

View File

@ -38,7 +38,7 @@ export async function getTaskDetail({
const task = result.tasks[0];
// 使用prompt生成器獲取最終prompt
const prompt = await getGetTaskDetailPrompt({
const prompt = getGetTaskDetailPrompt({
taskId,
task,
});
@ -53,7 +53,7 @@ export async function getTaskDetail({
};
} catch (error) {
// 使用prompt生成器獲取錯誤訊息
const errorPrompt = await getGetTaskDetailPrompt({
const errorPrompt = getGetTaskDetailPrompt({
taskId,
error: error instanceof Error ? error.message : String(error),
});

View File

@ -55,7 +55,7 @@ export async function listTasks({ status }: z.infer<typeof listTasksSchema>) {
}, {} as Record<string, typeof tasks>);
// 使用prompt生成器獲取最終prompt
const prompt = await getListTasksPrompt({
const prompt = getListTasksPrompt({
status,
tasks: tasksByStatus,
allTasks: filteredTasks,

View File

@ -4,7 +4,6 @@ import { fileURLToPath } from "url";
import { getAllTasks } from "../../models/taskModel.js";
import { TaskStatus, Task } from "../../types/index.js";
import { getPlanTaskPrompt } from "../../prompts/index.js";
import { getMemoryDir } from "../../utils/paths.js";
// 開始規劃工具
export const planTaskSchema = z.object({
@ -34,7 +33,8 @@ export async function planTask({
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const PROJECT_ROOT = path.resolve(__dirname, "../../..");
const MEMORY_DIR = await getMemoryDir();
const DATA_DIR = process.env.DATA_DIR || path.join(PROJECT_ROOT, "data");
const MEMORY_DIR = path.join(DATA_DIR, "memory");
// 準備所需參數
let completedTasks: Task[] = [];
@ -56,7 +56,7 @@ export async function planTask({
}
// 使用prompt生成器獲取最終prompt
const prompt = await getPlanTaskPrompt({
const prompt = getPlanTaskPrompt({
description,
requirements,
existingTasksReference,

View File

@ -44,7 +44,7 @@ export async function queryTask({
const results = await searchTasksWithCommand(query, isId, page, pageSize);
// 使用prompt生成器獲取最終prompt
const prompt = await getQueryTaskPrompt({
const prompt = getQueryTaskPrompt({
query,
isId,
tasks: results.tasks,

View File

@ -24,7 +24,7 @@ export async function reflectTask({
analysis,
}: z.infer<typeof reflectTaskSchema>) {
// 使用prompt生成器獲取最終prompt
const prompt = await getReflectTaskPrompt({
const prompt = getReflectTaskPrompt({
summary,
analysis,
});

View File

@ -209,7 +209,7 @@ export async function splitTasks({
}
// 使用prompt生成器獲取最終prompt
const prompt = await getSplitTasksPrompt({
const prompt = getSplitTasksPrompt({
updateMode,
createdTasks,
allTasks,

View File

@ -247,7 +247,7 @@ export async function splitTasksRaw({
}
// 使用prompt生成器獲取最終prompt
const prompt = await getSplitTasksPrompt({
const prompt = getSplitTasksPrompt({
updateMode,
createdTasks,
allTasks,

View File

@ -84,7 +84,7 @@ export async function updateTaskContent({
content: [
{
type: "text" as const,
text: await getUpdateTaskContentPrompt({
text: getUpdateTaskContentPrompt({
taskId,
validationError:
"行號設置無效:必須同時設置起始行和結束行,且起始行必須小於結束行",
@ -111,7 +111,7 @@ export async function updateTaskContent({
content: [
{
type: "text" as const,
text: await getUpdateTaskContentPrompt({
text: getUpdateTaskContentPrompt({
taskId,
emptyUpdate: true,
}),
@ -128,7 +128,7 @@ export async function updateTaskContent({
content: [
{
type: "text" as const,
text: await getUpdateTaskContentPrompt({
text: getUpdateTaskContentPrompt({
taskId,
}),
},
@ -164,7 +164,7 @@ export async function updateTaskContent({
content: [
{
type: "text" as const,
text: await getUpdateTaskContentPrompt({
text: getUpdateTaskContentPrompt({
taskId,
task,
success: result.success,

View File

@ -69,7 +69,7 @@ export async function verifyTask({
}
// 使用prompt生成器獲取最終prompt
const prompt = await getVerifyTaskPrompt({ task, score, summary });
const prompt = getVerifyTaskPrompt({ task, score, summary });
return {
content: [

View File

@ -74,7 +74,7 @@ export async function processThought(
}
// 格式化思維輸出
const formattedThought = await getProcessThoughtPrompt(thoughtData);
const formattedThought = getProcessThoughtPrompt(thoughtData);
// 返回成功響應
return {

View File

@ -1,116 +0,0 @@
import path from "path";
import { fileURLToPath } from "url";
import { Server } from "@modelcontextprotocol/sdk/server/index.js";
import fs from "fs";
// 取得專案根目錄
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const PROJECT_ROOT = path.resolve(__dirname, "../..");
// 全局 server 實例
let globalServer: Server | null = null;
/**
* server
*/
export function setGlobalServer(server: Server): void {
globalServer = server;
}
/**
* server
*/
export function getGlobalServer(): Server | null {
return globalServer;
}
/**
* DATA_DIR
* server listRoots使 file:// 開頭的 root + "/data"
* 使
*/
export async function getDataDir(): Promise<string> {
const server = getGlobalServer();
let rootPath: string | null = null;
if (server) {
try {
const roots = await server.listRoots();
// 找出第一筆 file:// 開頭的 root
if (roots.roots && roots.roots.length > 0) {
const firstFileRoot = roots.roots.find((root) =>
root.uri.startsWith("file://")
);
if (firstFileRoot) {
// 從 file:// URI 中提取實際路徑
rootPath = firstFileRoot.uri.replace("file://", "");
}
}
} catch (error) {
console.error("Failed to get roots:", error);
}
}
// 處理 process.env.DATA_DIR
if (process.env.DATA_DIR) {
if (path.isAbsolute(process.env.DATA_DIR)) {
// 如果 DATA_DIR 是絕對路徑,返回 "DATA_DIR/rootPath最後一個資料夾名稱"
if (rootPath) {
const lastFolderName = path.basename(rootPath);
return path.join(process.env.DATA_DIR, lastFolderName);
} else {
// 如果沒有 rootPath直接返回 DATA_DIR
return process.env.DATA_DIR;
}
} else {
// 如果 DATA_DIR 是相對路徑,返回 "rootPath/DATA_DIR"
if (rootPath) {
return path.join(rootPath, process.env.DATA_DIR);
} else {
// 如果沒有 rootPath使用 PROJECT_ROOT
return path.join(PROJECT_ROOT, process.env.DATA_DIR);
}
}
}
// 如果沒有 DATA_DIR使用預設邏輯
if (rootPath) {
return path.join(rootPath, "data");
}
// 最後回退到專案根目錄
return path.join(PROJECT_ROOT, "data");
}
/**
*
*/
export async function getTasksFilePath(): Promise<string> {
const dataDir = await getDataDir();
return path.join(dataDir, "tasks.json");
}
/**
*
*/
export async function getMemoryDir(): Promise<string> {
const dataDir = await getDataDir();
return path.join(dataDir, "memory");
}
/**
* WebGUI
*/
export async function getWebGuiFilePath(): Promise<string> {
const dataDir = await getDataDir();
return path.join(dataDir, "WebGUI.md");
}
/**
*
*/
export function getProjectRoot(): string {
return PROJECT_ROOT;
}

View File

@ -1,153 +0,0 @@
import express, { Request, Response } from "express";
import getPort from "get-port";
import path from "path";
import fs from "fs";
import fsPromises from "fs/promises";
import { fileURLToPath } from "url";
import {
getDataDir,
getTasksFilePath,
getWebGuiFilePath,
} from "../utils/paths.js";
export async function createWebServer() {
// 創建 Express 應用
const app = express();
// 儲存 SSE 客戶端的列表
let sseClients: Response[] = [];
// 發送 SSE 事件的輔助函數
function sendSseUpdate() {
sseClients.forEach((client) => {
// 檢查客戶端是否仍然連接
if (!client.writableEnded) {
client.write(
`event: update\ndata: ${JSON.stringify({
timestamp: Date.now(),
})}\n\n`
);
}
});
// 清理已斷開的客戶端 (可選,但建議)
sseClients = sseClients.filter((client) => !client.writableEnded);
}
// 設置靜態文件目錄
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const publicPath = path.join(__dirname, "..", "..", "src", "public");
const TASKS_FILE_PATH = await getTasksFilePath(); // 使用工具函數取得檔案路徑
app.use(express.static(publicPath));
// 設置 API 路由
app.get("/api/tasks", async (req: Request, res: Response) => {
try {
// 使用 fsPromises 保持異步讀取
const tasksData = await fsPromises.readFile(TASKS_FILE_PATH, "utf-8");
res.json(JSON.parse(tasksData));
} catch (error) {
// 確保檔案不存在時返回空任務列表
if ((error as NodeJS.ErrnoException).code === "ENOENT") {
res.json({ tasks: [] });
} else {
res.status(500).json({ error: "Failed to read tasks data" });
}
}
});
// 新增SSE 端點
app.get("/api/tasks/stream", (req: Request, res: Response) => {
res.writeHead(200, {
"Content-Type": "text/event-stream",
"Cache-Control": "no-cache",
Connection: "keep-alive",
// 可選: CORS 頭,如果前端和後端不在同一個 origin
// "Access-Control-Allow-Origin": "*",
});
// 發送一個初始事件或保持連接
res.write("data: connected\n\n");
// 將客戶端添加到列表
sseClients.push(res);
// 當客戶端斷開連接時,將其從列表中移除
req.on("close", () => {
sseClients = sseClients.filter((client) => client !== res);
});
});
// 定義 writeWebGuiFile 函數
async function writeWebGuiFile(port: number | string) {
try {
// 讀取 TEMPLATES_USE 環境變數並轉換為語言代碼
const templatesUse = process.env.TEMPLATES_USE || "en";
const getLanguageFromTemplate = (template: string): string => {
if (template === "zh") return "zh-TW";
if (template === "en") return "en";
// 自訂範本預設使用英文
return "en";
};
const language = getLanguageFromTemplate(templatesUse);
const websiteUrl = `[Task Manager UI](http://localhost:${port}?lang=${language})`;
const websiteFilePath = await getWebGuiFilePath();
const DATA_DIR = await getDataDir();
try {
await fsPromises.access(DATA_DIR);
} catch (error) {
await fsPromises.mkdir(DATA_DIR, { recursive: true });
}
await fsPromises.writeFile(websiteFilePath, websiteUrl, "utf-8");
} catch (error) {}
}
return {
app,
sendSseUpdate,
async startServer() {
// 獲取可用埠
const port = process.env.WEB_PORT || (await getPort());
// 啟動 HTTP 伺服器
const httpServer = app.listen(port, () => {
// 在伺服器啟動後開始監聽檔案變化
try {
// 檢查檔案是否存在,如果不存在則不監聽 (避免 watch 報錯)
if (fs.existsSync(TASKS_FILE_PATH)) {
fs.watch(TASKS_FILE_PATH, (eventType, filename) => {
if (
filename &&
(eventType === "change" || eventType === "rename")
) {
// 稍微延遲發送,以防短時間內多次觸發 (例如編輯器保存)
// debounce sendSseUpdate if needed
sendSseUpdate();
}
});
}
} catch (watchError) {}
// 將 URL 寫入 WebGUI.md
writeWebGuiFile(port).catch((error) => {});
});
// 設置進程終止事件處理 (確保移除 watcher)
const shutdownHandler = async () => {
// 關閉所有 SSE 連接
sseClients.forEach((client) => client.end());
sseClients = [];
// 關閉 HTTP 伺服器
await new Promise<void>((resolve) => httpServer.close(() => resolve()));
};
process.on("SIGINT", shutdownHandler);
process.on("SIGTERM", shutdownHandler);
return httpServer;
},
};
}