Skip to content

docs: update README with batch operations and list_tasks tool #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
evalor merged 3 commits into from
Nov 25, 2025
Merged

docs: update README with batch operations and list_tasks tool #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
44a154a
Initial plan
Copilot Nov 25, 2025
afbc6bc
docs: update README with batch operations and list_tasks tool
Copilot Nov 25, 2025
0b31e80
docs: fix grammar in README.md
Copilot Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ For AI agents that may run in YOLO mode, you can enable read-only mode by adding

## 🛠️ Available MCP Tools

This server provides **14 MCP tools** across three categories, ✔️ 100% implemented all API interfaces described in the open platform documentation.
This server provides **15 MCP tools** across three categories. ✔️ It has implemented 100% of the API interfaces described in the open platform documentation.

| Category | Tool Name | Description | Required Parameters |
| ----------- | ------------------- | -------------------------------------------------------- | --------------------- |
Expand All @@ -299,13 +299,14 @@ This server provides **14 MCP tools** across three categories, ✔️ 100% imple
| | `create_project` | Create a new project | `name` |
| | `update_project` | Update existing project | `projectId` |
| | `delete_project` | Delete a project (⚠️ irreversible) | `projectId` |
| **Task** | `create_task` | Create a new task (supports subtasks, reminders, repeat) | `title`, `projectId` |
| **Task** | `list_tasks` | List tasks with filtering (batch query across projects) | - |
| | `create_task` | Create task(s) (supports batch & subtasks) | `tasks[]` |
| | `get_task` | Get detailed task information | `projectId`, `taskId` |
| | `update_task` | Update existing task | `taskId`, `projectId` |
| | `delete_task` | Delete a task (⚠️ irreversible) | `projectId`, `taskId` |
| | `complete_task` | Mark task as completed | `projectId`, `taskId` |
| | `update_task` | Update task(s) (supports batch updates) | `tasks[]` |
| | `delete_task` | Delete task(s) (⚠️ irreversible, supports batch) | `tasks[]` |
| | `complete_task` | Mark task(s) as completed (supports batch) | `tasks[]` |

> **Note**: In read-only mode, only read operations are available (`get_auth_url`, `check_auth_status`, `revoke_auth`, `list_projects`, `get_project`, `get_project_data`, `get_task`). All write/delete operations are blocked for security.
> **Note**: In read-only mode, only read operations are available (`get_auth_url`, `check_auth_status`, `revoke_auth`, `list_projects`, `get_project`, `get_project_data`, `list_tasks`, `get_task`). All write/delete operations are blocked for security.

## 📁 Project Structure

Expand All @@ -316,10 +317,12 @@ src/
├── oauth-server.ts # Local callback server
├── config.ts # Configuration management
├── token.ts # Token persistence
└── tools/ # MCP tools (14 total)
├── utils/ # Utility modules
│ └── batch.ts # Batch execution utilities
└── tools/ # MCP tools (15 total)
├── auth/ # OAuth tools (3)
├── project/ # Project management (6)
└── task/ # Task management (5)
└── task/ # Task management (6)
```

## 🗺️ Roadmap
Expand All @@ -331,12 +334,13 @@ src/
- [x] Complete project management (CRUD)
- [x] Complete task management (subtasks, reminders, repeat)
- [x] Read-only mode for AI agents
- [x] Batch operations support (create/update/delete/complete multiple tasks)
- [x] List tasks with filtering (cross-project queries, date/priority filters)
- [x] Inbox task operations support

### 🚀 Next Steps

- [ ] Batch operations support (create/update/delete multiple tasks)
- [ ] Optimize tool descriptions for better LLM integration
- [ ] Inbox task operations support
- [ ] Add parameters to limit the ProjectId that the MCP can access

### 💡 Future Ideas
Expand Down
24 changes: 14 additions & 10 deletions README_zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ npm run debug:hot # 使用 tsx watch 运行（实验性）

## 🛠️ 可用的 MCP 工具

此服务器提供 **14 个 MCP 工具**，分为三类，✔️ 100% 实现了开放平台文档中描述的所有 API 接口。
此服务器提供 **15 个 MCP 工具**，分为三类，✔️ 100% 实现了开放平台文档中描述的所有 API 接口。

| 类别 | 工具名称 | 描述 | 必需参数 |
| ---------- | ------------------- | ------------------------------------ | --------------------- |
Expand All @@ -300,13 +300,14 @@ npm run debug:hot # 使用 tsx watch 运行（实验性）
| | `create_project` | 创建新项目 | `name` |
| | `update_project` | 更新现有项目 | `projectId` |
| | `delete_project` | 删除项目（⚠️ 不可逆） | `projectId` |
| **任务** | `create_task` | 创建新任务（支持子任务、提醒、重复） | `title`, `projectId` |
| **任务** | `list_tasks` | 列出任务（支持跨项目批量查询和过滤） | - |
| | `create_task` | 创建任务（支持批量创建和子任务） | `tasks[]` |
| | `get_task` | 获取任务详细信息 | `projectId`, `taskId` |
| | `update_task` | 更新现有任务 | `taskId`, `projectId` |
| | `delete_task` | 删除任务（⚠️ 不可逆） | `projectId`, `taskId` |
| | `complete_task` | 标记任务为已完成 | `projectId`, `taskId` |
| | `update_task` | 更新任务（支持批量更新） | `tasks[]` |
| | `delete_task` | 删除任务（⚠️ 不可逆，支持批量） | `tasks[]` |
| | `complete_task` | 标记任务为已完成（支持批量） | `tasks[]` |

> **注意**：在只读模式下，仅可用读取操作（`get_auth_url`、`check_auth_status`、`revoke_auth`、`list_projects`、`get_project`、`get_project_data`、`get_task`）。所有写入/删除操作均被禁用以确保安全。
> **注意**：在只读模式下，仅可用读取操作（`get_auth_url`、`check_auth_status`、`revoke_auth`、`list_projects`、`get_project`、`get_project_data`、`list_tasks`、`get_task`）。所有写入/删除操作均被禁用以确保安全。

## 📁 项目结构

Expand All @@ -317,10 +318,12 @@ src/
├── oauth-server.ts # 本地回调服务器
├── config.ts # 配置管理
├── token.ts # 令牌持久化
└── tools/ # MCP 工具（14 个）
├── utils/ # 工具模块
│ └── batch.ts # 批量执行工具
└── tools/ # MCP 工具（15 个）
├── auth/ # OAuth 工具（3 个）
├── project/ # 项目管理（6 个）
└── task/ # 任务管理（5 个）
└── task/ # 任务管理（6 个）
```

## 🗺️ 路线图
Expand All @@ -332,12 +335,13 @@ src/
- [x] 完整的项目管理（CRUD）
- [x] 完整的任务管理（子任务、提醒、重复）
- [x] 针对 AI 代理的只读模式
- [x] 批量操作支持（批量创建/更新/删除/完成任务）
- [x] 任务列表查询（跨项目查询、日期/优先级过滤）
- [x] 收集箱任务操作支持

### 🚀 下一步计划

- [ ] 批量操作支持（创建/更新/删除多个任务）
- [ ] 优化工具描述，增强 LLM 集成
- [ ] 收集箱任务操作支持
- [ ] 添加参数以限制MCP可访问的ProjectId

### 💡 未来展望
Expand Down