Skip to content

feat: add search_docs tool for searching Plane documentation #158

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

Open
sriramveeraghanta wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: add search_docs tool for searching Plane documentation #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37fb244
feat: add search_docs tool for searching Plane documentation
sriramveeraghanta Jun 19, 2026
34f477b
feat: enhance search_docs tool with full-text retrieval option.
akhil-vamshi-konam Jun 26, 2026
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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,12 @@ The server provides comprehensive tools for interacting with Plane. All tools us
|-----------|-------------|
| `get_me` | Get current authenticated user information |

### Documentation

| Tool Name | Description |
|-----------|-------------|
| `search_docs` | Full-text search of Plane's official docs (docs.plane.so and developers.plane.so); returns ranked pages with snippets and URLs, or full page text with `full_text=True` |

**Total Tools**: 100+ tools across 20 categories

## Development
Expand Down
7 changes: 7 additions & 0 deletions plane_mcp/instructions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,11 @@
delete_work_item by work item id (set parent=<work item id> to nest).
5. List an epic's children: list_work_items(project_id, pql='childOf("<EPIC-IDENTIFIER>")')
using the epic's human-readable identifier (e.g. "PROJ-12") from retrieve_work_item.

## Documentation

For any how / what / why question about using or building on Plane, call
search_docs before action tools (create_*, update_*, delete_*) — those change
data, they do not explain features. Read a page in full with full_text=True,
limit=1.
"""
2 changes: 2 additions & 0 deletions plane_mcp/tools/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
from fastmcp import FastMCP

from plane_mcp.tools.cycles import register_cycle_tools
from plane_mcp.tools.docs import register_docs_tools
from plane_mcp.tools.initiatives import register_initiative_tools
from plane_mcp.tools.intake import register_intake_tools
from plane_mcp.tools.labels import register_label_tools
Expand Down Expand Up @@ -48,3 +49,4 @@ def register_tools(mcp: FastMCP) -> None:
register_workspace_tools(mcp)
register_milestone_tools(mcp)
register_pql_tools(mcp)
register_docs_tools(mcp)
Loading