[Do not merge] Add MCP docs #105
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for MCP (Model Context Protocol) servers functionality to the Devant platform. It introduces comprehensive documentation covering the creation, management, and usage of MCP servers generated from existing REST services.
- Added a new navigation section "Create MCP servers" to the documentation structure
- Created detailed documentation for generating MCP servers from existing REST services
- Included instructions for tool modification, deployment, and testing using the MCP Inspector
Reviewed Changes
Copilot reviewed 2 out of 7 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| en/mkdocs.yml | Added navigation entry for MCP servers documentation |
| en/docs/mcp-servers/generate-mcp-servers.md | Complete documentation guide for creating and managing MCP servers |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| - You will be redirected to the Developer Portal’s representation of the service. | ||
| - Click Subscribe and create an application. | ||
|
|
||
| 💡 Note: Once the MCP server is also published to the Developer Portal, subscribe the same application to it as well. |
There was a problem hiding this comment.
[nitpick] Using emoji characters (💡) in technical documentation can cause rendering issues in some documentation systems and may not be accessible to all users. Consider using standard markdown formatting like 'Note:' or an admonition block instead.
| 💡 Note: Once the MCP server is also published to the Developer Portal, subscribe the same application to it as well. | |
| !!!note | |
| Once the MCP server is also published to the Developer Portal, subscribe the same application to it as well. |
|
|
||
|  | ||
|
|
||
| 💡 Note: Clicking Connect sends an Initialize call to the MCP Server deployed in the gateway, establishing a connection. |
There was a problem hiding this comment.
[nitpick] Using emoji characters (💡) in technical documentation can cause rendering issues in some documentation systems and may not be accessible to all users. Consider using standard markdown formatting like 'Note:' or an admonition block instead.
| 💡 Note: Clicking Connect sends an Initialize call to the MCP Server deployed in the gateway, establishing a connection. | |
| !!!note | |
| Clicking Connect sends an Initialize call to the MCP Server deployed in the gateway, establishing a connection. |
|
We'll be keep this PR open until the MCP fixes are available in production. |
|
|
||
| In summary, Devant provides the following capabilities related to MCP. | ||
|
|
||
| 1. Create MCP Servers from existing HTTP services. |
There was a problem hiding this comment.
Let's rephrase it to devant wording
Integrations as APIs
| In summary, Devant provides the following capabilities related to MCP. | ||
|
|
||
| 1. Create MCP Servers from existing HTTP services. | ||
| 2. Automatically generate the MCP tool schemas. |
There was a problem hiding this comment.
These are sub parts of point 1. Please rephrase
|
|
||
| 4. Click **Create**. This creates the project and takes you to the project home page. | ||
|
|
||
| ### Create MCP Servers for existing HTTP integrations |
|
|
||
| ### Create MCP Servers for existing HTTP integrations | ||
|
|
||
| 1. Navigate to an HTTP integration under the category `Integration as API` from Devant. At the top right corner, you will be able to see a button named `Generate MCP server`. |
There was a problem hiding this comment.
May be HTTP based Integration as API
|
@pcnfernando / @Bhashinee since the blocked PR is merged, can we start reviewing these docs? |
|
|
||
| For more information, refer to the official [specification](https://modelcontextprotocol.io/introduction). | ||
|
|
||
| ## Remote MCP Servers with Devant |
There was a problem hiding this comment.
Second level sentences should be in sentence case.
|
|
||
| 💡 Note: Clicking Connect sends an Initialize call to the MCP Server deployed in the gateway, establishing a connection. | ||
|
|
||
| 6. Invoke MCP Tools |
There was a problem hiding this comment.
These should be in sentence case, check and fix all the places.
| @@ -0,0 +1,139 @@ | |||
| # Overview | |||
There was a problem hiding this comment.
File name and the title should match. And the file name is the one appearing in the URL too, so always use meanningful file names.
|
We need to updated all screenshots to use the newer ui look |
|
@SashenkaG will be working on the review comments |
|
Updated docs and resolved reviews in #142 |
|
|
||
| ## Prerequisites | ||
|
|
||
| ### Create an Organization |
There was a problem hiding this comment.
All headers below Level 1 should use sentence case.
| ### Create an Organization | |
| ### Create an organization |
|
|
||
| This creates the organization and opens the organization home page. | ||
|
|
||
| ### Create a Project |
There was a problem hiding this comment.
| ### Create a Project | |
| ### Create a project |
| !!!info | ||
| The MCP Servers created in Devant currently support **2025-03-16** specification. | ||
|
|
||
| ## Modify Tools of your MCP Server |
There was a problem hiding this comment.
| ## Modify Tools of your MCP Server | |
| ## Modify tools of your MCP Server |
5 participants
Purpose
$subject.
Related issue: https://github.com/wso2-enterprise/devant/issues/1542