Skip to content

Added docs for deploying MCP Servers in Devant#176

Open
chamodperera wants to merge 1 commit intowso2:mainfrom
chamodperera:main
Open

Added docs for deploying MCP Servers in Devant#176
chamodperera wants to merge 1 commit intowso2:mainfrom
chamodperera:main

Conversation

@chamodperera
Copy link
Copy Markdown

@chamodperera chamodperera commented Apr 9, 2026

Purpose

Added a new page in the docs for deploying MCP Servers in Devant

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

  • Unit tests

    Code coverage information

  • Integration tests

    Details about the test cases and coverage

Security checks

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added a comprehensive quick-start guide for developing and deploying MCP servers using WSO2 Integrator: BI and Devant platform. Provides detailed prerequisite setup instructions, step-by-step integration development workflow, source control management guidance, testing via MCP Playground, production promotion procedures, complete endpoint access guidance, and comprehensive build history tracking and visibility options.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 9, 2026

Walkthrough

A new quick-start guide documentation file was added to help developers create and deploy their first MCP server using WSO2 Integrator: BI. The guide covers prerequisites, server creation, extension setup, service development, deployment to Devant, and testing through the MCP Playground.

Changes

Cohort / File(s) Summary
Documentation Addition
en/docs/quick-start-guides/develop-your-first-mcp-server.md
New quick-start guide for developing MCP servers with WSO2 Integrator: BI, including setup prerequisites, server creation workflow, deployment steps, and testing procedures via Devant's MCP Playground.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A guide hops into view, so shiny and new,
WSO2 servers and Devant too!
With steps neat and clear, from start until test,
Our documentation now guides devs to their best! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is largely incomplete, with only the Purpose section filled out; most required sections are unfilled placeholders, making it insufficient for understanding the full scope and implications of the change. Complete the Goals, Approach, Release note, Documentation, and other key sections; use 'N/A' with explanations where sections don't apply rather than leaving placeholder text.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding documentation for deploying MCP Servers in Devant, which matches the added documentation file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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 and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (2)
en/docs/quick-start-guides/develop-your-first-mcp-server.md (2)

3-3: Inconsistent product naming in description.

The description uses "WSO2 Integrator BI" but throughout the document the product is consistently referred to as "WSO2 Integrator: BI" (with a colon). Consider updating for consistency.

✏️ Proposed fix for consistency
-description: Build your first MCP server with Devant by WSO2. Learn to create and deploy MCP-based integrations using WSO2 Integrator BI.
+description: Build your first MCP server with Devant by WSO2. Learn to create and deploy MCP-based integrations using WSO2 Integrator: BI.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@en/docs/quick-start-guides/develop-your-first-mcp-server.md` at line 3,
Update the front-matter description to use the consistent product name "WSO2
Integrator: BI" (with the colon) so it matches the rest of the document; locate
the YAML description field labeled "description" and change "WSO2 Integrator BI"
to "WSO2 Integrator: BI".

52-67: Consider improving consistency in terminology and formatting.

Minor inconsistencies detected:

  1. Capitalization: "Build Status" (line 52, 57) vs "build status" (line 55) - consider standardizing
  2. UI element formatting: Inconsistent use of bold, backticks, and combinations (e.g., "Configure to Continue" vs "Apply" vs "Promote")

While these don't impact functionality, consistent formatting improves readability and professionalism.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@en/docs/quick-start-guides/develop-your-first-mcp-server.md` around lines 52
- 67, Standardize terminology and UI formatting in the steps: choose a single
casing for the build status (use "Build Status" everywhere instead of "build
status") and make UI elements consistent (use bold without backticks for button
names and labels, e.g., change "**`Apply`**" to "**Apply**", ensure "**Configure
to Continue**" and "**Promote**" match that style). Update occurrences of "Build
Status", "build status", "**Configure to Continue**", "**`Apply`**", and
"**Promote**" in the text so capitalization and markup are uniform across all
steps.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@en/docs/quick-start-guides/develop-your-first-mcp-server.md`:
- Line 39: The external link in the sentence referencing the "MCP Service
Integration" guide is broken; locate the link string
"https://bi.docs.wso2.com/integration-guides/ai/mcp-service/mcp-service/" in the
document and replace it with the correct, reachable WSO2 MCP Service Integration
URL (verify the working URL on WSO2's docs site first) so the anchor text "MCP
Service Integration" points to a 200-successful page.

---

Nitpick comments:
In `@en/docs/quick-start-guides/develop-your-first-mcp-server.md`:
- Line 3: Update the front-matter description to use the consistent product name
"WSO2 Integrator: BI" (with the colon) so it matches the rest of the document;
locate the YAML description field labeled "description" and change "WSO2
Integrator BI" to "WSO2 Integrator: BI".
- Around line 52-67: Standardize terminology and UI formatting in the steps:
choose a single casing for the build status (use "Build Status" everywhere
instead of "build status") and make UI elements consistent (use bold without
backticks for button names and labels, e.g., change "**`Apply`**" to
"**Apply**", ensure "**Configure to Continue**" and "**Promote**" match that
style). Update occurrences of "Build Status", "build status", "**Configure to
Continue**", "**`Apply`**", and "**Promote**" in the text so capitalization and
markup are uniform across all steps.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4065b3c2-c7ac-405f-acc8-5e9594bb3097

📥 Commits

Reviewing files that changed from the base of the PR and between fb0b7be and d7bc3d2.

⛔ Files ignored due to path filters (1)
  • en/docs/assets/img/get-started/deploy-your-first-mcp-server/test-in-mcp-playground.gif is excluded by !**/*.gif
📒 Files selected for processing (1)
  • en/docs/quick-start-guides/develop-your-first-mcp-server.md

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