Open
Conversation
Contributor
|
Swagger Changes
_ __ __
/tyk/mcps/{apiID}:
/tyk/mcps:
_| |_ _ / _|/ _| between swagger-prev.yml
+ one list entry added:
+ two map entries added:
/ _' | | | | |_| |_ and swagger-current.yml
\__,_|\__, |_| |_| returned two differences
paths
tags
| (_| | |_| | _| _| |
Contributor
|
This PR introduces OpenAPI documentation for the new MCP (Model Context Protocol) Proxies API. By adding the specification to Files Changed Analysis
Architecture & Impact Assessment
Scope Discovery & Context ExpansionThis PR only modifies the API documentation, but it implies the existence of a corresponding implementation within the gateway. The documentation change itself has minimal risk, but a reviewer should confirm that it accurately reflects the behavior of the underlying code. To understand the full scope, a reviewer should investigate the following areas in the codebase:
{
"text": "This PR introduces OpenAPI documentation for the new MCP (Model Context Protocol) Proxies API. By adding the specification to `swagger.yml`, it makes the API for managing MCP configurations discoverable and provides a clear contract for its endpoints, including paths, request/response schemas, and descriptions.
## Files Changed Analysis
- **`swagger.yml`**: Modified (+172 additions, 0 deletions)
- The sole change is the addition of 172 lines to the gateway's main Swagger definition file.
- A new tag, `MCP Proxies`, is introduced to group the new endpoints.
- The change defines the full CRUD (Create, Read, Update, Delete) API specification for the `/tyk/mcps` and `/tyk/mcps/{apiID}` endpoints.
## Architecture & Impact Assessment
- **What this PR accomplishes**
This PR officially documents the RESTful API for managing MCP Proxies on a Tyk Gateway. By adding these definitions to `swagger.yml`, the API becomes part of the formal specification, enabling auto-generated documentation, client libraries, and easier integration for developers and administrators.
- **Key technical changes introduced**
- **New API Tag**: Adds an `MCP Proxies` tag to group related endpoints.
- **New API Paths**: Defines two new paths:
- `/tyk/mcps`: For listing all MCP proxies (`GET`) and creating new ones (`POST`).
- `/tyk/mcps/{apiID}`: For retrieving (`GET`), updating (`PUT`), and deleting (`DELETE`) a specific MCP proxy by its ID.
- **Schema Definitions**: Specifies that MCP Proxies are defined as Tyk OAS documents that include an `x-tyk-api-gateway` vendor extension for MCP-specific configuration.
- **Affected system components**
- **Tyk Gateway Management API**: This is the primary component affected. The change exposes new management capabilities through the existing API.
- **API Consumers**: Developers, administrators, and automation tools that interact with the Tyk Gateway API will now have a formal specification for managing MCP Proxies.
- The underlying MCP functionality is not changed; only the API that manages it is now documented.
- **API Flow Diagram**
```mermaid
sequenceDiagram
participant Client as Admin/CI/CD
participant Gateway as Tyk Gateway API
Client->>+Gateway: POST /tyk/mcps (Create MCP Proxy)
Gateway-->>-Client: 200 OK (key)
Client->>+Gateway: GET /tyk/mcps/{apiID} (Read MCP Proxy)
Gateway-->>-Client: 200 OK (OAS Definition)
Client->>+Gateway: PUT /tyk/mcps/{apiID} (Update MCP Proxy)
Gateway-->>-Client: 200 OK (key)
Client->>+Gateway: DELETE /tyk/mcps/{apiID} (Delete MCP Proxy)
Gateway-->>-Client: 200 OK (key)
Client->>+Gateway: POST /tyk/reload (Apply Changes)
Gateway-->>-Client: 200 OKScope Discovery & Context ExpansionThis PR only modifies the API documentation, but it implies the existence of a corresponding implementation within the gateway. The documentation change itself has minimal risk, but a reviewer should confirm that it accurately reflects the behavior of the underlying code. To understand the full scope, a reviewer should investigate the following areas in the codebase:
|
Contributor
Performance Issues (1)
Performance Issues (1)
Powered by Visor from Probelabs Last updated: 2026-04-15T15:32:12.478Z | Triggered by: pr_updated | Commit: 3c6efeb 💡 TIP: You can chat with Visor using |
Contributor
|
API Changes no api changes detected |
Contributor
🚨 Jira Linter FailedCommit: The Jira linter failed to validate your PR. Please check the error details below: 🔍 Click to view error detailsNext Steps
This comment will be automatically deleted once the linter passes. |
|
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.
Description
Related Issue
Motivation and Context
How This Has Been Tested
Screenshots (if appropriate)
Types of changes
Checklist