Skip to content

[MI 4.6.0] Add documentation for MCP Server feature - #2354

Open
arunans23 wants to merge 1 commit into
wso2:mainfrom
arunans23:mcp-server-docs
Open

[MI 4.6.0] Add documentation for MCP Server feature#2354
arunans23 wants to merge 1 commit into
wso2:mainfrom
arunans23:mcp-server-docs

Conversation

@arunans23

@arunans23 arunans23 commented Jul 7, 2026

Copy link
Copy Markdown
Member

Purpose

Describe the problems, issues, or needs driving this feature/fix and include links to related issues in the following format: Resolves issue1, issue2, etc.

$subject

Related to wso2/product-integrator-mi#4939, wso2-extensions/mi-inbound-mcp#1

Screen recording:

Screen.Recording.2026-07-07.at.10.31.18-720p.mov

@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

This pull request adds two new documentation pages to the MI docs site: a guide for creating an MCP Server artifact and a reference page for MCP inbound endpoint properties. The MCP server guide covers artifact creation, tool addition from APIs/sequences, configuration updates, and example source XML. The reference page documents the inbound endpoint's configuration properties, syntax, and tool definition schema. Corresponding navigation entries were added to mkdocs.yml.

Changes

File Summary
en/docs/develop/creating-artifacts/creating-an-mcp-server.md New guide covering MCP Server artifact creation, tool addition, configuration, and connection details
en/docs/reference/synapse-properties/inbound-endpoints/listening-inbound-endpoints/mcp-inbound-endpoint-properties.md New reference page documenting MCP inbound endpoint properties and tool definition schema
en/mkdocs.yml Added navigation entries for both new pages

Related Issues: None specified.

Related PRs: None specified.

Suggested labels: documentation

Suggested reviewers: None specified.

Poem
A rabbit hops through docs anew,
MCP tools now in full view,
Servers built with ports and CORS,
Sequences mapped, no missing source,
Nav links added, clean and true —
Hop along, the guide's for you!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is mostly a template stub and omits required sections like Goals, Approach, Release note, and testing details. Replace the placeholders and fill in the required sections with concrete details, links, testing, security checks, and related artifacts.
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly and concisely describes the main change: adding MCP Server documentation for MI 4.6.0.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant