docs(markdown-hybrid-search-mcp): Introduce Design Documentation#115
Merged
docs(markdown-hybrid-search-mcp): Introduce Design Documentation#115
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new public subproject scaffold for markdown-hybrid-search-mcp and introduces extensive design documentation under .AGENTS/DESIGN/ to specify the intended v1 architecture and constraints.
Changes:
- Added a new Python package scaffold (
markdown_hybrid_search_mcp) with placeholder modules and a README pointing to the design doc. - Added design spec + clarification/review documents under
src/public/app/markdown-hybrid-search-mcp/.AGENTS/DESIGN/. - Registered the new subproject in the repo’s
uvworkspace and Pyrefly include list.
Reviewed changes
Copilot reviewed 25 out of 25 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/public/app/markdown-hybrid-search-mcp/src/markdown_hybrid_search_mcp/server.py | Placeholder module docstring for future MCP server entrypoint. |
| src/public/app/markdown-hybrid-search-mcp/src/markdown_hybrid_search_mcp/init.py | Package docstring scaffold. |
| src/public/app/markdown-hybrid-search-mcp/pyproject.toml | New subproject packaging metadata + FastMCP dependency. |
| src/public/app/markdown-hybrid-search-mcp/README.md | High-level intent and pointer to design documentation. |
| src/public/app/markdown-hybrid-search-mcp/.AGENTS/DESIGN/v1.md | Main v1 design specification. |
| src/public/app/markdown-hybrid-search-mcp/.AGENTS/DESIGN/REVIEW_v1_*.md | Design review iterations captured as docs. |
| src/public/app/markdown-hybrid-search-mcp/.AGENTS/DESIGN/CLARIFY*.md | Clarifications/decisions captured as docs. |
| pyproject.toml | Adds the new subproject to uv workspace members + Pyrefly project includes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.