Skip to content

Commit bfd0603

Browse files
docs: fix PAT endpoint URL, add version requirements, document all 100+ tool (makeplane#116)
1 parent b4fd09c commit bfd0603

1 file changed

Lines changed: 120 additions & 2 deletions

File tree

README.md

Lines changed: 120 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ A Model Context Protocol (MCP) server for Plane integration. This server provide
1313

1414
The server supports three transport methods. **We recommend using `uvx`** as it doesn't require installation.
1515

16+
**Requirements**:
17+
- **Python 3.10+** (for stdio transport, via `uvx`)
18+
- **Node.js 22+** (for remote transports, via `npx`)
19+
1620
### 1. Stdio Transport (for local use)
1721

1822
**MCP Client Configuration** (using uvx - recommended):
@@ -58,7 +62,7 @@ Connect to the hosted Plane MCP server using OAuth authentication.
5862

5963
Connect to the hosted Plane MCP server using a Personal Access Token (PAT).
6064

61-
**URL**: `https://mcp.plane.so/api-key/mcp`
65+
**URL**: `https://mcp.plane.so/http/api-key/mcp`
6266

6367
**Headers**:
6468
- `Authorization: Bearer <PAT_TOKEN>`
@@ -218,13 +222,127 @@ The server provides comprehensive tools for interacting with Plane. All tools us
218222
| `update_work_item_property` | Update a work item property with partial data |
219223
| `delete_work_item_property` | Delete a work item property by ID |
220224

225+
### Epics
226+
227+
| Tool Name | Description |
228+
|-----------|-------------|
229+
| `list_epics` | List all epics in a project |
230+
| `create_epic` | Create a new epic |
231+
| `retrieve_epic` | Retrieve an epic by ID |
232+
| `update_epic` | Update an epic by ID |
233+
| `delete_epic` | Delete an epic by ID |
234+
235+
### Milestones
236+
237+
| Tool Name | Description |
238+
|-----------|-------------|
239+
| `list_milestones` | List all milestones in a project |
240+
| `create_milestone` | Create a new milestone |
241+
| `retrieve_milestone` | Retrieve a milestone by ID |
242+
| `update_milestone` | Update a milestone by ID |
243+
| `delete_milestone` | Delete a milestone by ID |
244+
| `add_work_items_to_milestone` | Add work items to a milestone |
245+
| `remove_work_items_from_milestone` | Remove work items from a milestone |
246+
| `list_milestone_work_items` | List work items in a milestone |
247+
248+
### Labels
249+
250+
| Tool Name | Description |
251+
|-----------|-------------|
252+
| `list_labels` | List all labels in a project |
253+
| `create_label` | Create a new label |
254+
| `retrieve_label` | Retrieve a label by ID |
255+
| `update_label` | Update a label by ID |
256+
| `delete_label` | Delete a label by ID |
257+
258+
### States
259+
260+
| Tool Name | Description |
261+
|-----------|-------------|
262+
| `list_states` | List all states in a project |
263+
| `create_state` | Create a new state |
264+
| `retrieve_state` | Retrieve a state by ID |
265+
| `update_state` | Update a state by ID |
266+
| `delete_state` | Delete a state by ID |
267+
268+
### Work Item Comments
269+
270+
| Tool Name | Description |
271+
|-----------|-------------|
272+
| `list_work_item_comments` | List comments for a work item |
273+
| `retrieve_work_item_comment` | Retrieve a specific comment for a work item |
274+
| `create_work_item_comment` | Create a comment for a work item |
275+
| `update_work_item_comment` | Update a comment for a work item |
276+
| `delete_work_item_comment` | Delete a comment for a work item |
277+
278+
### Work Item Links
279+
280+
| Tool Name | Description |
281+
|-----------|-------------|
282+
| `list_work_item_links` | List links for a work item |
283+
| `retrieve_work_item_link` | Retrieve a specific link for a work item |
284+
| `create_work_item_link` | Create a link for a work item |
285+
| `update_work_item_link` | Update a link for a work item |
286+
| `delete_work_item_link` | Delete a link for a work item |
287+
288+
### Work Item Types
289+
290+
| Tool Name | Description |
291+
|-----------|-------------|
292+
| `list_work_item_types` | List all work item types in a project |
293+
| `create_work_item_type` | Create a new work item type |
294+
| `retrieve_work_item_type` | Retrieve a work item type by ID |
295+
| `update_work_item_type` | Update a work item type by ID |
296+
| `delete_work_item_type` | Delete a work item type by ID |
297+
298+
### Work Item Relations
299+
300+
| Tool Name | Description |
301+
|-----------|-------------|
302+
| `list_work_item_relations` | List relations for a work item |
303+
| `create_work_item_relation` | Create relations for a work item |
304+
| `remove_work_item_relation` | Remove a relation from a work item |
305+
306+
### Work Item Activities
307+
308+
| Tool Name | Description |
309+
|-----------|-------------|
310+
| `list_work_item_activities` | List activities for a work item |
311+
| `retrieve_work_item_activity` | Retrieve a specific activity for a work item |
312+
313+
### Work Logs
314+
315+
| Tool Name | Description |
316+
|-----------|-------------|
317+
| `list_work_logs` | List work logs for a work item |
318+
| `create_work_log` | Create a work log for a work item |
319+
| `update_work_log` | Update a work log for a work item |
320+
| `delete_work_log` | Delete a work log for a work item |
321+
322+
### Pages
323+
324+
| Tool Name | Description |
325+
|-----------|-------------|
326+
| `retrieve_workspace_page` | Retrieve a workspace page by ID |
327+
| `retrieve_project_page` | Retrieve a project page by ID |
328+
| `create_workspace_page` | Create a workspace page |
329+
| `create_project_page` | Create a project page |
330+
331+
### Workspaces
332+
333+
| Tool Name | Description |
334+
|-----------|-------------|
335+
| `get_workspace_members` | Get all members of the current workspace |
336+
| `get_workspace_features` | Get features of the current workspace |
337+
| `update_workspace_features` | Update features of the current workspace |
338+
221339
### Users
222340

223341
| Tool Name | Description |
224342
|-----------|-------------|
225343
| `get_me` | Get current authenticated user information |
226344

227-
**Total Tools**: 55+ tools across 8 categories
345+
**Total Tools**: 100+ tools across 20 categories
228346

229347
## Development
230348

0 commit comments

Comments
 (0)