Create an MCP Server API product

更新时间:
复制 MD 格式

You can use Open Platform to package an existing MCP Server as an API product and publish it to a Developer Portal, where developers can browse and subscribe to it. This topic describes how to create an API product from an MCP Server.

Create an API product

Before you begin, complete the following tasks:

Log in to the Open Platform console. In the left-side navigation pane, choose API Products, then click Create API Product.

In the panel that opens, configure the following parameters.

Parameter

Description

Product Name

A unique name for the product, such as api-product. This parameter is required.

Product Description

A brief summary of the product's features and purpose. This parameter is required.

Product Type

Select MCP Server. This parameter is required.

Product Category

Select a category for the product. Custom categories are supported. This parameter is optional.

Auto-approve Subscriptions

If you enable this option, the system automatically approves developer subscription requests. This setting can be configured for both the Developer Portal and the API product, but the setting for the API product takes precedence.

Product Icon

Select an icon for the product. You can provide a URL or upload a local file. This parameter is optional.

After you configure the parameters, click OK to create the API product.

Associate API

You must associate an API with the API product before publishing it to a Developer Portal.

  1. On the API product details page, click Associate API.

  2. Select the target gateway instance and MCP Server.

  3. Click Associate.

After a successful association, the product status changes to To be published, and the page displays the MCP Server endpoint information.

User guide

A user guide helps developers quickly understand and use the API product. A comprehensive guide that includes a product introduction, an API reference, and code samples helps developers get started faster.

  1. On the API product details page, click the User Guide tab.

  2. Use the Markdown editor to write the guide, or upload an existing Markdown file.

  3. Click Save.

Publish to portal

  1. Confirm that the product status is To be published.

  2. Click Publish to Portal.

  3. Select the target portal.

  4. Click Publish.

After publishing, developers can browse and subscribe to the API product in the Developer Portal.