-
Epic
-
Resolution: Done
-
Major
-
None
-
None
-
None
-
MCP Tools for Techdocs
-
False
-
-
False
-
Done
-
RHDHPLAN-43 - Model Context Protocol (MCP) Server in Red Hat Developer Hub
-
0% To Do, 0% In Progress, 100% Done
-
-
Epic Goal
- Develop MCP (Model Context Protocol) tools that enable seamless interaction with Backstage Techdocs functionality
- Provide developers and AI assistants with programmatic access to discover and retrieve technical documentation from Backstage entities
- Enable efficient documentation workflows through standardized MCP tool interfaces
Why is this important?
- Backstage Techdocs contains critical technical documentation that developers and AI assistants need to access programmatically
- Current manual navigation through Backstage UI is inefficient for automated workflows and AI-assisted development
- MCP tools will enable AI assistants to help developers find relevant documentation quickly and accurately
- Standardized access patterns will improve developer productivity and reduce time spent searching for documentation
- Enhanced integration capabilities will support better documentation discovery and content retrieval workflows
Scenarios
- List available techdocs for each entity.
- Provide an MCP tool to list entities that have techdocs, and provide a list of techdocs for each entity, along with their links. Properly format the data to allow the MCP client to properly manipulate the response
- Fetch the content of techdocs
- Provide an MCP tool to return the content of a techdoc associated with a given entity.
Acceptance Criteria (Mandatory)
- One or more MCP tool plugins implementing the actions listed above
- Proper Data Formatting - All MCP tool responses must be properly structured and formatted to enable easy manipulation by MCP clients and AI assistants
- Error Handling - Implement comprehensive error handling for scenarios including missing entities, inaccessible techdocs, and network issues
- CI - MUST be running successfully with tests automated
- Release Technical Enablement - Provide necessary release enablement details and documents including deployment guides, configuration requirements, and usage examples