feat(swagger): swagger docs for mcp endpoints #4
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
* Added /plugin/mcp/runs endpoint for list_runs() * Added /plugin/mcp/runs/detail endpoint for get_run_detail() * These methods were already implemented in mcp_api.py but not registered as routes
- Created comprehensive API schemas using Marshmallow in app/api/v2/schemas/: * base_schemas.py: Common schemas (ErrorResponse, ModelConfigSchema) * execute_schemas.py: AI agent execution request/response schemas * status_schemas.py: Run status tracking schemas * rag_schemas.py: RAG file upload/list schemas * runs_schemas.py: MLflow run listing and detail schemas - Updated mcp_api.py with aiohttp_apispec decorators: * Added @docs() tags for Swagger UI organization * Added @request_schema() for request validation * Added @response_schema() for response documentation * Decorated all 6 endpoints: execute, status, upload_rag, list_rag, list_runs, get_run_detail
HackedRico
changed the title
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.
Description
This pull request adds Marshmallow schemas to the MCP plugin API and integrates them with
aiohttp_apispecto enable automatic validation and OpenAPI documentation to work with core Calderaapi/docs.API Schema Definitions
base_schemas.py,execute_schemas.py,status_schemas.py,rag_schemas.py, andruns_schemas.pyto define standardized request and response formats for error handling, execution, status, RAG file management, and run history.API Endpoint Documentation and Validation
app/mcp_api.pyto import the new schemas and annotate all major endpoints (execute,status,upload_rag,list_rag,list_runs,get_run_detail) with OpenAPI documentation and request/response schema validation usingaiohttp_apispec.Endpoint Registration
/plugin/mcp/runs,/plugin/mcp/runs/detail) in the plugin hook for full run listing and detail retrieval.Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Fresh install of Caldera with MCP Plugin to ensure proper population of MCP plugin Swagger Docs endpoints.
Checklist: