-
Notifications
You must be signed in to change notification settings - Fork 23
Added docs for deploying MCP Servers in Devant #176
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
chamodperera
wants to merge
1
commit into
wso2:main
Choose a base branch
from
chamodperera:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file added
BIN
+3.8 MB
.../assets/img/get-started/deploy-your-first-mcp-server/test-in-mcp-playground.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
67 changes: 67 additions & 0 deletions
67
en/docs/quick-start-guides/develop-your-first-mcp-server.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| --- | ||
| title: Develop Your First MCP Server | ||
| description: Build your first MCP server with Devant by WSO2. Learn to create and deploy MCP-based integrations using WSO2 Integrator BI. | ||
| --- | ||
|
|
||
| # Develop Your First MCP Server | ||
|
|
||
| ## Overview | ||
|
|
||
| In this guide, you will: | ||
|
|
||
| - Create a simple MCP server. | ||
| - Use WSO2 Integrator: BI to develop the MCP service integration. | ||
| - Push the MCP server to Devant from WSO2 Integrator: BI. This will automatically build and deploy it to the development environment. | ||
| - Test the MCP server. | ||
| - Once verified, promote it to the production environment and expose it as an API. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| 1. GitHub account: [Create a GitHub account](https://github.com/signup) if you don't have one already. | ||
| 2. If signing in to Devant for the first time, [create an organization](../references/create-an-organization.md) to begin with. | ||
| 3. VS Code: [Install VS Code](https://code.visualstudio.com/download) if you don't have it installed already. | ||
|
|
||
| ## Step 1: Create the new integration | ||
|
|
||
| 1. Import a new repository to begin your integration. Refer [Import a Repository](../references/import-a-repository.md) for more details. | ||
| 2. Select the **Technology** as `WSO2 Integrator: BI`. | ||
| 3. Choose the **Integration Type** as `MCP Server` and click **Create**. | ||
|
|
||
| This redirects you to the **Create New Integration in VS Code** page. | ||
|
|
||
| ## Step 2: Install the WSO2 Integrator: BI extension and open the integration | ||
|
|
||
| 1. Install WSO2 Integrator: BI extension. Refer [Install and Set Up WSO2 Integrator: BI](../references/install-and-setup-wso2-integrator-bi.md) for more details. | ||
| 2. Click **Develop in WSO2 Integrator: BI**. This will clone your integration project and open it in BI. | ||
|
|
||
| ## Step 3: Develop the MCP Server in WSO2 Integrator: BI | ||
|
|
||
| To build your MCP Server using WSO2 Integrator: BI, refer to the [MCP Service Integration](https://bi.docs.wso2.com/integration-guides/ai/mcp-service/mcp-service/) guide on the Learn page. | ||
|
|
||
| ## Step 4: Push to Devant | ||
|
|
||
| 1. Click the **Source Control** icon on the sidebar. | ||
| 2. Click **+** to stage all changes. | ||
| 3. Add an appropriate commit message and commit. | ||
| 4. Click **Sync Changes** to push the changes to remote. | ||
| 5. Go back to the **Design** view using the back arrow in the top left corner. | ||
| 6. From the right side panel, click the **View in Devant** to view this integration in Devant. | ||
|
|
||
| ## Step 5: Test MCP Server | ||
|
|
||
| 1. Once you push the changes, the overview page of the Devant MCP Server will automatically refresh and show you the **Latest Commit** and automatically build and show the **Build Status**. | ||
|
|
||
| !!! note | ||
| The build process may take some time. Once complete, the build status changes to **Success**. You can see the Build History by clicking **Build** in the left navigation. | ||
|
|
||
| 2. Once the **Build Status** shows `Build completed`, it will be automatically deployed into the development environment. | ||
|
|
||
| 3. Then, click the **Configure to Continue** button, enter the configurable values, and click **`Apply`**. | ||
|
|
||
| 4. Navigate to the **Test** page of your MCP Server in Devant and use the **MCP Playground** to explore available tools. Select a tool, provide the required inputs, and execute it to test functionality. | ||
|
|
||
| <a href="{{base_path}}/assets/img/get-started/deploy-your-first-mcp-server/test-in-mcp-playground.gif"><img src="{{base_path}}/assets/img/get-started/deploy-your-first-mcp-server/test-in-mcp-playground.gif" alt="Test in MCP Playground" width="80%"></a> | ||
|
|
||
| 5. After successfully testing, you can promote your MCP Server to production by clicking the **Promote** button. | ||
|
|
||
| 6. Once deployed to production, you can access your MCP server through the exposed endpoints and integrate it with your applications. | ||
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.
Uh oh!
There was an error while loading. Please reload this page.