wso2 / wso2/docs-api-platform

Doc Feedback: Contradictory information regarding Lifecycle Coupling of MCP Servers and API Proxies

Open Beginner friendly
#177 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
2
Forks
64
Avg merge
1d 9h
Merged PRs (30d)
34

Description

Description:
There is a theoretical inconsistency in how the relationship between MCP Servers and API Proxies is described.

Location :
https://wso2.com/bijira/docs/mcp-servers/design-mcp-servers/#mcp-servers-for-existing-api-proxies

The Conflict:
The text states: "the MCP Server is associated with the API Proxy, their lifecycles are not tightly coupled."
The very next sentence states: "unpublishing or undeploying the API Proxy can disrupt the MCP Server created using it."

Technical Detail:
In systems architecture, if the functional availability of Component A (MCP Server) is dependent on the deployment state of Component B (API Proxy), they are tightly coupled. Describing them as "not tightly coupled" is technically misleading and could lead to accidental production outages during API maintenance.

Suggested Fix:
Clarify the architectural dependency. If the MCP Server acts as a proxy/wrapper for the API, it should be described as dependent or tightly coupled to the underlying API Proxy's lifecycle.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the MCP Servers for Existing API Proxies section at the linked documentation URL and compare the two adjacent lifecycle statements. Clarify the dependency so the wording is technically consistent, then verify the rendered page communicates the API Proxy impact of unpublishing or undeploying it.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.