docs(mcp): add MCP module documentation #208
Merged
Conversation
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
Add comprehensive documentation for the PLEIADES MCP server integration: - README.md: Installation, quick start, tool reference, troubleshooting - manifest-format.md: YAML frontmatter specification with validation rules - integration-pattern.md: Reusable pattern for adding MCP to scientific packages Changes include: - Mermaid diagrams for better web rendering - Clarified decorator approaches (FastMCP built-in vs custom registry) - Documented isotope selection priority hierarchy Closes #170 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the MCP (Model Context Protocol) module in PLEIADES, enabling AI-assisted neutron resonance analysis. The documentation provides installation guides, API references, manifest specifications, and reusable integration patterns for adding MCP capabilities to other scientific packages.
Key Changes
- Complete MCP module documentation with installation, configuration, and usage instructions
- Manifest format specification detailing YAML frontmatter structure and validation rules
- Integration pattern guide providing a reusable architecture template for other scientific software packages
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| docs/mcp/README.md | Installation instructions, quick start guide, complete tool reference with parameters/returns, workflow diagrams, backend options, and troubleshooting |
| docs/mcp/manifest-format.md | YAML frontmatter specification with field references, isotope composition options, validation rules, and complete examples |
| docs/mcp/integration-pattern.md | Architecture overview, decorator pattern implementation, step-by-step integration guide, design principles, and code size estimates |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Add timezone Z to ISO-8601 timestamp example (manifest-format.md) - Change URL to next branch instead of feature branch (integration-pattern.md) - Remove nova from backend options in MCP tool description (tools.py) - Use _mcp_registry instead of _tool_registry for accuracy (integration-pattern.md) - Use sys.exit() instead of exit() (integration-pattern.md) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
docs/mcp/Changes
docs/mcp/README.md
.mcp.jsonconfigurationdocs/mcp/manifest-format.md
docs/mcp/integration-pattern.md
Test plan
Closes #170
🤖 Generated with Claude Code