Skip to content

Commit 0b73bdd

Browse files
authored
Merge pull request #102 from TomMaSS/feature/ready-tasks
Organize MCP tools table by group with section headers
2 parents 27474b4 + f5567eb commit 0b73bdd

1 file changed

Lines changed: 82 additions & 40 deletions

File tree

README.md

Lines changed: 82 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
![PRDforge Demo](demo.gif)
66

7-
PRD Forge splits your product requirements into independently addressable sections stored in PostgreSQL, then gives Claude surgical read/write access through 34 MCP tools. The result: edits that used to burn ~15,000 tokens now cost 500-2,000 — an **85-95% reduction** in context per operation.
7+
PRD Forge splits your product requirements into independently addressable sections stored in PostgreSQL, then gives Claude surgical read/write access through 33 MCP tools. The result: edits that used to burn ~15,000 tokens now cost 500-2,000 — an **85-95% reduction** in context per operation.
88

99
## The Problem
1010

@@ -22,7 +22,7 @@ Each section stores both its full **content** and a short **summary** (1-3 sente
2222

2323
## Features
2424

25-
- **34 MCP tools** — read, write, search, import/export, manage dependencies, track revisions, resolve comments
25+
- **33 MCP tools** — read, write, search, import/export, manage dependencies, track revisions, resolve comments
2626
- **Multi-user auth** — Better Auth (email/password + Google OAuth), 5 roles (owner/admin/editor/commenter/viewer), org-scoped access control
2727
- **Real-time collaboration** — WebSocket presence, live section updates across clients
2828
- **Project templates** — start with Blank, SaaS MVP, Mobile App, or API Design — pre-built section structures with starter content
@@ -165,46 +165,88 @@ Chat is an experimental feature, disabled by default. Enable per-project in **Se
165165

166166
## MCP Tools Reference
167167

168-
34 MCP tools across 10 groups. See **[docs/tool-reference.md](docs/tool-reference.md)** for workflows and usage examples.
168+
See **[docs/tool-reference.md](docs/tool-reference.md)** for workflows and usage examples.
169169

170170
<details>
171-
<summary>All 34 MCP Tools</summary>
172-
173-
| Tool | Group | Description |
174-
|:-----|:------|:------------|
175-
| `prd_list_projects` | Project | List all projects with section counts |
176-
| `prd_create_project` | Project | Create project (optional template: `saas-mvp`, `mobile-app`, `api-design`) |
177-
| `prd_delete_project` | Project | Delete project and all sections (cascades) |
178-
| `prd_list_sections` | Section | List sections — metadata only, no content |
179-
| `prd_read_section` | Section | Read full section content + dependency context summaries |
180-
| `prd_create_section` | Section | Create new section with content, tags, type |
181-
| `prd_update_section` | Section | Update fields, auto-revision on content change, atomic comment resolve |
182-
| `prd_delete_section` | Section | Delete section (warns about dependencies) |
183-
| `prd_move_section` | Section | Change sort_order or parent section |
184-
| `prd_reorder_sections` | Section | Reorder sections by slug list (unlisted keep relative order) |
185-
| `prd_duplicate_section` | Section | Copy section with new slug |
186-
| `prd_merge_sections` | Section | Merge source into target (content, deps, comments, children) |
187-
| `prd_add_dependency` | Deps | Add/update dependency link (idempotent) |
188-
| `prd_remove_dependency` | Deps | Remove a dependency link |
189-
| `prd_suggest_dependencies` | Deps | Auto-suggest deps via content similarity (TF-IDF) |
190-
| `prd_list_comments` | Comments | List all comments across project with section pointers |
191-
| `prd_add_comment` | Comments | Add inline comment anchored to selected text |
192-
| `prd_resolve_comment` | Comments | Resolve or reopen a comment |
193-
| `prd_delete_comment` | Comments | Delete a comment |
194-
| `prd_add_comment_reply` | Replies | Add a reply to an inline comment |
195-
| `prd_get_settings` | Settings | Get project settings (merged defaults + overrides) |
196-
| `prd_update_settings` | Settings | Update project settings |
197-
| `prd_get_overview` | Context | Project overview with section summaries (~10% of full doc) |
198-
| `prd_search` | Context | Full-text or tag search across sections |
199-
| `prd_get_changelog` | Context | Recent revision history across all sections |
200-
| `prd_token_stats` | Context | Token savings statistics for the project |
201-
| `prd_get_revisions` | Revision | List revision metadata for a section |
202-
| `prd_read_revision` | Revision | Read a specific historical revision's content |
203-
| `prd_rollback_section` | Revision | Rollback to a previous revision (current saved as backup) |
204-
| `prd_export_markdown` | Export | Export full document as assembled markdown |
205-
| `prd_import_markdown` | Import | Import from markdown (configurable heading level or delimiter) |
206-
| `prd_import_url` | Import | Import markdown from URL (SSRF-protected, Google Docs/GitHub support) |
207-
| `prd_bulk_status` | Batch | Update status for multiple sections at once |
171+
<summary>All 33 MCP Tools</summary>
172+
173+
#### Project (3)
174+
175+
| Tool | Description |
176+
|:-----|:------------|
177+
| `prd_list_projects` | List all projects with section counts |
178+
| `prd_create_project` | Create project (optional template: `saas-mvp`, `mobile-app`, `api-design`) |
179+
| `prd_delete_project` | Delete project and all sections (cascades) |
180+
181+
#### Sections (9)
182+
183+
| Tool | Description |
184+
|:-----|:------------|
185+
| `prd_list_sections` | List sections — metadata only, no content |
186+
| `prd_read_section` | Read full content + dependency context summaries |
187+
| `prd_create_section` | Create new section with content, tags, type |
188+
| `prd_update_section` | Update fields, auto-revision on content change, atomic comment resolve |
189+
| `prd_delete_section` | Delete section (warns about dependencies) |
190+
| `prd_move_section` | Change sort_order or parent section |
191+
| `prd_reorder_sections` | Reorder sections by slug list |
192+
| `prd_duplicate_section` | Copy section with new slug |
193+
| `prd_merge_sections` | Merge source into target (content, deps, comments, children) |
194+
195+
#### Dependencies (3)
196+
197+
| Tool | Description |
198+
|:-----|:------------|
199+
| `prd_add_dependency` | Add/update dependency link (idempotent) |
200+
| `prd_remove_dependency` | Remove a dependency link |
201+
| `prd_suggest_dependencies` | Auto-suggest deps via content similarity (TF-IDF) |
202+
203+
#### Comments (5)
204+
205+
| Tool | Description |
206+
|:-----|:------------|
207+
| `prd_list_comments` | List all comments across project with section pointers |
208+
| `prd_add_comment` | Add inline comment anchored to selected text |
209+
| `prd_add_comment_reply` | Add a reply to an inline comment |
210+
| `prd_resolve_comment` | Resolve or reopen a comment |
211+
| `prd_delete_comment` | Delete a comment |
212+
213+
#### Context & Search (4)
214+
215+
| Tool | Description |
216+
|:-----|:------------|
217+
| `prd_get_overview` | Project overview with section summaries (~10% of full doc) |
218+
| `prd_search` | Full-text or tag search across sections |
219+
| `prd_get_changelog` | Recent revision history across all sections |
220+
| `prd_token_stats` | Token savings statistics for the project |
221+
222+
#### Revisions (3)
223+
224+
| Tool | Description |
225+
|:-----|:------------|
226+
| `prd_get_revisions` | List revision metadata for a section |
227+
| `prd_read_revision` | Read a specific historical revision's content |
228+
| `prd_rollback_section` | Rollback to a previous revision (current saved as backup) |
229+
230+
#### Import & Export (3)
231+
232+
| Tool | Description |
233+
|:-----|:------------|
234+
| `prd_export_markdown` | Export full document as assembled markdown |
235+
| `prd_import_markdown` | Import from markdown (configurable heading level or delimiter) |
236+
| `prd_import_url` | Import from URL (SSRF-protected, Google Docs/GitHub support) |
237+
238+
#### Settings (2)
239+
240+
| Tool | Description |
241+
|:-----|:------------|
242+
| `prd_get_settings` | Get project settings (merged defaults + overrides) |
243+
| `prd_update_settings` | Update project settings |
244+
245+
#### Batch (1)
246+
247+
| Tool | Description |
248+
|:-----|:------------|
249+
| `prd_bulk_status` | Update status for multiple sections at once |
208250

209251
</details>
210252

0 commit comments

Comments
 (0)