From 34cf8e2b26638e6dc14c8ece39865fbe78a59c4c Mon Sep 17 00:00:00 2001 From: Liujian <824010343@qq.com> Date: Fri, 11 Apr 2025 11:03:20 +0800 Subject: [PATCH] update global mcp tool's description --- controller/mcp/iml.go | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/controller/mcp/iml.go b/controller/mcp/iml.go index 6e7c6a4b..2aa4d660 100644 --- a/controller/mcp/iml.go +++ b/controller/mcp/iml.go @@ -46,24 +46,24 @@ func (i *imlMcpController) OnComplete() { s := server.NewMCPServer("APIPark MCP Server", "1.0.0", server.WithLogging()) s.AddTool( mcp2.NewTool( - "apipark_service_list", - mcp2.WithDescription("This tool is a standardized interface provided by the Apipark platform under the MCP (Model Context Protocol) framework, designed to retrieve metadata for all registered services in bulk. By invoking this tool, users can efficiently explore the complete list of published services and their core attributes, serving as a prerequisite for subsequent actions such as querying detailed API lists via service IDs, requesting access permissions, or integrating services."), + "service_list", + mcp2.WithDescription("This tool can retrieve a list of registered services on APIPark, including key information such as service ID, name, description, and API list within the service. Support keyword search to quickly narrow down the search scope. After obtaining the service ID, you can use this ID to call the tool openapi_document to obtain the openapi document of the service for the corresponding service, preparing for subsequent API calls."), mcp2.WithString("keyword", mcp2.Description("Keyword for fuzzy search")), ), i.mcpModule.Services, ) s.AddTool( mcp2.NewTool( - "apipark_service_api_list", - mcp2.WithDescription("This tool is a standardized MCP (Model Context Protocol) interface provided by the Apipark platform, designed to retrieve OpenAPI specification documents for all APIs under a specified service using its service ID. By invoking this tool, users gain precise access to detailed API definitions (including endpoints, parameters, request/response schemas) for debugging, integration, or client SDK generation."), + "openapi_document", + mcp2.WithDescription("This tool returns the openAPI documentation for the corresponding service. The format supports the specifications of OpenAPI v3 and OpenAPI v2."), mcp2.WithString("service", mcp2.Description("Service ID")), ), i.mcpModule.APIs, ) s.AddTool( mcp2.NewTool( - "apipark_invoke_api", - mcp2.WithDescription("This tool is a core MCP (Model Context Protocol) interface provided by the Apipark platform, enabling users to programmatically invoke APIs using metadata from apipark_service_api_list (API schemas). It acts as a unified gateway for executing API requests with built-in authentication, parameter validation, and error handling, returning structured responses for integration workflows."), + "invoke_api", + mcp2.WithDescription("This tool can directly make API calls. Before calling this tool, it is necessary to construct relevant parameters based on the corresponding API's openAPI documentation, including query, header, body, method, path, and other parameters. By using this tool, no authentication related information needs to be transmitted, that is, no request header Authorization needs to be transmitted."), mcp2.WithString("path", mcp2.Description("API path"), mcp2.Required()), mcp2.WithString("method", mcp2.Description("API method"), mcp2.Required()), mcp2.WithString("content-type", mcp2.Description("API Request Content-Type. If method is POST,PUT,PATCH, it must be set. If not set, it will be ignored.")),