Overview
This document describes how to view, create, and manage MCP services in DataBuddy, including three typical sources: automatic exposure based on Catalog functions, adding external MCP/API, and one-click installation from the partner plugin marketplace. Configured MCP services can be directly called by high-code Agents.
Prerequisites
Before you start this operation, make sure the following prerequisites are met:
You have activated the DataBuddy service and completed workspace initialization.
Prepare the corresponding resources based on the type of MCP you want to create:
Catalog Function: A usable UC Function has been created in Catalog (created in SQL Editor or Notebook).
External MCP / API: The address, authentication method, and credentials of the external service are known.
Partner Plugin: Prepare credentials such as Tencent Cloud AK/SK, API keys, or username and password as required by the plugin.
Use Limits
Limit | Description |
Number of tools per MCP service | Up to 1,000 |
Method for adding external MCP | Phase 1 supports import through mcp.json |
Refresh MCP service status | The list displays the status from the last view, does not refresh in real time. To trigger the latest validation, go to the details page or click Refresh. |
Going to the MCP List
2. Switch to the target region and Workspace at the top.
3. In the left sidebar, choose Data Applications > Agents and go to the MCP tab.
The MCP list displays all available MCP services in the current Workspace, including service name, category, author, number of tools, update time, and service status. You can perform a fuzzy search by name, filter by category, or click Refresh above the list to trigger a status check for the selected MCP.
Operation Steps
Method 1: Creating an MCP Service Based on Catalog Functions
After a Catalog function is created, it is automatically exposed as an MCP service. You do not need to create it separately on the MCP page.
1. Go to Data Engineering > Studio and open any Notebook or SQL script.
2. Write and execute a CREATE FUNCTION statement to register the function under the specified Catalog and Schema, for example:
CREATE OR REPLACE FUNCTION my_catalog.sales.compute_gmv(
start_date STRING COMMENT 'Start date for statistics, in yyyy-MM-dd format',
end_date STRING COMMENT 'End date for statistics, in yyyy-MM-dd format'
)
RETURNS DOUBLE
COMMENT 'Calculate the GMV within the specified time range'
RETURN (
SELECT SUM(amount) FROM my_catalog.sales.orders
WHERE order_date BETWEEN start_date AND end_date
);
1. After the function is created successfully, return to the MCP list. You can see the tools corresponding to the function in the MCPs categorized as Catalog Function.
2. (Optional) Click a list item to go to the details page and confirm the tool name, parameter description, and service address.
Tip
The tool name, parameter description, and required status come from the parameter names and COMMENT in the function definition. We recommend that you provide a clear Chinese or English COMMENT for each parameter when creating a function, so that the Agent can better understand when to call the tool.
Method 2: Adding an External MCP/API Service
If you already have a self-built MCP Server or want to integrate a third-party HTTP API, you can register it as an external MCP service.
1. On the MCP list, click Add External MCP Tool.
2. Select the registration method:
mcp.json Registration: Paste the standard MCP JSON configuration in the text box. After the platform saves it, a connectivity check is performed, and the check status can be viewed on the details page.
1. Configuration is MCP Connection: It is selected by default and cannot be deselected in the connection details step.
2. Click Add. After submission, the page will indicate whether the addition was successful or failed.
3. After the addition is successful, the new MCP appears in the list (categorized as External API). Click it to go to the details page and view the check status, service address, and tool list.
Note:
For services registered through mcp.json, the MCP status is marked as unavailable when the check fails, but the record is retained. Go to the details page to view the error cause, correct the configuration, and perform the check again.
Method 3: Installing MCP from the Plugin Marketplace with One Click
The MCP plugin marketplace provides out-of-the-box MCP tools, allowing you to quickly integrate various third-party capabilities.
1. On the MCP list, click MCP Marketplace.
2. In the upper-right corner of the plugin details page, click Install:
Plugins That Do Not Require Authentication: The installation is completed directly, and the plugin appears in the MCP list immediately after installation.
Plugins That Require Authentication: An installation dialog appears. Enter the credentials as prompted (see Plugin Authentication below), select I agree to the User Agreement and Privacy Policy, and then click Install. 1. After successful installation, a toast notification appears, and the newly added MCP service is visible in the list.
Viewing MCP Details
Click any item in the MCP list to go to its details page, where you can view the following information:
Section | Content. |
Header Information | MCP name, category, description, author (official MCPs are displayed as "Wedata Official"), number of tools, and update time |
Service Status | Whether the current MCP is available. The latest validation is triggered when you go to the details page or click Refresh. |
Service Address | URL for Agent/SDK calls. Click the copy button to display "Copied Successfully". |
Tool List | Each tool displays its name, description, input parameter Schema, and output structure Schema. |
Parameter Description
External MCP Authentication
External MCP currently supports registration through mcp.json.
Verification Result
After the operation is completed, you can confirm that the MCP service is available in the following ways:
1. In the MCP list, find the MCP you just created or installed, and its service status is displayed as available.
2. Go to the details page and click Refresh. The status remains available, and the tool list and parameter Schema are displayed correctly.
FAQs
Q: Why Is the Status Displayed in the MCP List Inconsistent with the Actual Status?
The MCP service status in the list does not refresh in real time and shows the status from the last time it was viewed. To trigger the latest check, go to the details page or click Refresh.
Q: What Should I Do If the Status Shows Unavailable After an External MCP Is Added via mcp.json?
Check the following:
1. Whether the JSON format is valid and whether the required fields are complete.
2. Whether the service address is accessible from the network where the DataBuddy platform resides (note the private network/VPC isolation).
3. Whether the credentials are correct and have not expired.
4. The specific validation error is visible on the details page. Correct the issue as prompted and validate again.
References
Creating and Managing Agents