mcp-server-esa 1.0.6 → 1.0.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Alibaba Cloud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.js

@@ -277,7 +277,7 @@ class Client {
 const service = new Client();
 const ROUTINE_CODE_COMMIT_TOOL = {
     name: 'routine_code_commit',
-    description: 'Commit a edge routine(ER) code. If it fails, please submit again.',
+    description: 'Save a code version for future modifications or release within an Edge Routine (ER).',
     inputSchema: {
         type: 'object',
         properties: {
@@ -348,7 +348,7 @@ const routine_code_commit = async (request)=>{
 };
 const ROUTINE_CODE_DEPLOY_TOOL = {
     name: 'routine_code_deploy',
-    description: 'Deploy a routine code, must be a valid semantic version. If version is not exist, should call routine_code_commit first',
+    description: 'Deploy a selected code version to the staging or production environment. If version is not exist, should call routine_code_commit first',
     inputSchema: {
         type: 'object',
         properties: {
@@ -433,7 +433,7 @@ const canary_area_list = async ()=>{
 };
 const DEPLOYMENT_DELETE_TOOL = {
     name: 'deployment_delete',
-    description: 'Delete a deployment',
+    description: 'Delete a specified code version associated with an Edge Routine (ER).',
     inputSchema: {
         type: 'object',
         properties: {
@@ -466,7 +466,7 @@ const deployment_delete = async (request)=>{
 };
 const ER_RECORD_CREATE_TOOL = {
     name: 'er_record_create',
-    description: 'Create a record',
+    description: 'Create a new record associated with an Edge Routine (ER)',
     inputSchema: {
         type: 'object',
         properties: {
@@ -492,7 +492,7 @@ const ER_RECORD_CREATE_TOOL = {
 };
 const ER_RECORD_DELETE_TOOL = {
     name: 'er_record_delete',
-    description: 'Delete a record',
+    description: 'Delete a specified record associated with an Edge Routine (ER).',
     inputSchema: {
         type: 'object',
         properties: {
@@ -522,7 +522,7 @@ const ER_RECORD_DELETE_TOOL = {
 };
 const ER_RECORD_LIST_TOOL = {
     name: 'er_record_list',
-    description: 'List all records',
+    description: 'List all records associated with a specific Edge Routine (ER).',
     inputSchema: {
         type: 'object',
         properties: {
@@ -586,7 +586,7 @@ const er_record_list = async (request)=>{
 };
 const ROUTE_CREATE_TOOL = {
     name: 'route_create',
-    description: 'Create a edge routine(ER) related route',
+    description: 'Create a new route associated with an Edge Routine (ER).',
     inputSchema: {
         type: 'object',
         properties: {
@@ -604,7 +604,7 @@ const ROUTE_CREATE_TOOL = {
             },
             route: {
                 type: 'string',
-                description: 'The route of the route, if mode is simple, this field is required'
+                description: 'The route of the route, if mode is simple, this field is required. For example: test.example.com/*'
             },
             rule: {
                 type: 'string',
@@ -616,7 +616,7 @@ const ROUTE_CREATE_TOOL = {
             },
             routeName: {
                 type: 'string',
-                description: 'The name of the route, use to identify the route'
+                description: 'The name of the route, use to identify the route. For example: test-route'
             },
             bypass: {
                 type: 'enum',
@@ -652,7 +652,7 @@ const ROUTE_CREATE_TOOL = {
 };
 const ROUTE_UPDATE_TOOL = {
     name: 'route_update',
-    description: 'Update a routine related route',
+    description: 'Modify the configuration of an existing Edge Routine route.',
     inputSchema: {
         type: 'object',
         properties: {
@@ -666,7 +666,7 @@ const ROUTE_UPDATE_TOOL = {
             },
             routeName: {
                 type: 'string',
-                description: 'The name of the route, use to identify the route'
+                description: 'The name of the route, use to identify the route.'
             },
             routeEnable: {
                 type: 'enum',
@@ -710,7 +710,7 @@ const ROUTE_UPDATE_TOOL = {
 };
 const ROUTE_DELETE_TOOL = {
     name: 'route_delete',
-    description: 'Delete a routine related route',
+    description: 'Delete a specified route associated with an Edge Routine (ER).',
     inputSchema: {
         type: 'object',
         properties: {
@@ -731,7 +731,7 @@ const ROUTE_DELETE_TOOL = {
 };
 const ROUTE_GET_TOOL = {
     name: 'route_get',
-    description: 'Get a routine related route',
+    description: 'Get details of a specific route associated with an Edge Routine (ER).',
     inputSchema: {
         type: 'object',
         properties: {
@@ -752,7 +752,7 @@ const ROUTE_GET_TOOL = {
 };
 const ROUTINE_ROUTE_LIST_TOOL = {
     name: 'routine_route_list',
-    description: 'List all routes of a routine',
+    description: 'List all routes associated with a specific Edge Routine (ER).',
     inputSchema: {
         type: 'object',
         properties: {
@@ -780,7 +780,7 @@ const ROUTINE_ROUTE_LIST_TOOL = {
 };
 const SITE_ROUTE_LIST_TOOL = {
     name: 'site_route_list',
-    description: 'List all routes of a site',
+    description: 'List all routes associated with a specific site.',
     inputSchema: {
         type: 'object',
         properties: {
@@ -916,7 +916,7 @@ const site_route_list = async (request)=>{
 };
 const ROUTINE_CREATE_TOOL = {
     name: 'routine_create',
-    description: 'Create a edge routine(ER).',
+    description: 'Create a new Edge Routine (ER) in your Alibaba Cloud account.',
     inputSchema: {
         type: 'object',
         properties: {
@@ -941,7 +941,7 @@ const ROUTINE_CREATE_TOOL = {
 };
 const ROUTINE_DELETE_TOOL = {
     name: 'routine_delete',
-    description: 'Delete a edge routine(ER).',
+    description: 'Delete an existing Edge Routine (ER) from your Alibaba Cloud account.',
     inputSchema: {
         type: 'object',
         properties: {
@@ -957,7 +957,7 @@ const ROUTINE_DELETE_TOOL = {
 };
 const ROUTINE_LIST_TOOL = {
     name: 'routine_list',
-    description: 'List all edge routines',
+    description: 'List all Edge Routines (ERs) in your Alibaba Cloud account.',
     inputSchema: {
         type: 'object',
         properties: {}
@@ -965,7 +965,7 @@ const ROUTINE_LIST_TOOL = {
 };
 const ROUTINE_GET_TOOL = {
     name: 'routine_get',
-    description: 'Get a edge routine detail by name',
+    description: 'Get a the details of a Edge Routine (ER).',
     inputSchema: {
         type: 'object',
         properties: {
@@ -1037,7 +1037,7 @@ const SITE_ACTIVE_LIST_TOOL = {
 };
 const SITE_MATCH_TOOL = {
     name: 'site_match',
-    description: 'Check which site under the account matches the user input， user must input recordName',
+    description: 'Identify which site in the account matches the provided input criteria.',
     inputSchema: {
         type: 'object',
         properties: {
@@ -1051,9 +1051,9 @@ const SITE_MATCH_TOOL = {
         ]
     }
 };
-const SITE_DNS_TYPE_A_RECORD_CREATE_TOOL = {
-    name: 'site_dns_type_a_record_create',
-    description: 'Create a A record for a site.',
+const SITE_DNS_A_RECORD_CREATE_TOOL = {
+    name: 'site_dns_a_record_create',
+    description: 'Create an A DNS record for a specified site.',
     inputSchema: {
         type: 'object',
         properties: {
@@ -1093,9 +1093,9 @@ const SITE_DNS_TYPE_A_RECORD_CREATE_TOOL = {
         ]
     }
 };
-const SITE_DNS_CNAME_DOMAIN_RECORD_CREATE_TOOL = {
-    name: 'site_dns_cname_domain_record_create',
-    description: 'Create a CNAME domain record for a site.',
+const SITE_DNS_CNAME_RECORD_CREATE_TOOL = {
+    name: 'site_dns_cname_record_create',
+    description: 'Create a CNAME DNS record for a specified site.',
     inputSchema: {
         type: 'object',
         properties: {
@@ -1137,7 +1137,7 @@ const SITE_DNS_CNAME_DOMAIN_RECORD_CREATE_TOOL = {
 };
 const SITE_RECORD_LIST_TOOL = {
     name: 'site_record_list',
-    description: 'List all records in a site',
+    description: 'List DNS records associated with a specific site.',
     inputSchema: {
         type: 'object',
         properties: {
@@ -1148,7 +1148,7 @@ const SITE_RECORD_LIST_TOOL = {
         }
     }
 };
-const site_dns_type_a_record_create = async (request)=>{
+const site_dns_a_record_create = async (request)=>{
     const res = await service.createRecord({
         ttl: 1,
         proxied: true,
@@ -1166,7 +1166,7 @@ const site_dns_type_a_record_create = async (request)=>{
         success: true
     };
 };
-const site_dns_cname_domain_record_create = async (request)=>{
+const site_dns_cname_record_create = async (request)=>{
     const res = await service.createRecord({
         ttl: 1,
         proxied: true,
@@ -1253,16 +1253,16 @@ const ESA_OPENAPI_ER_LIST = [
     ER_RECORD_CREATE_TOOL,
     ER_RECORD_DELETE_TOOL,
     ER_RECORD_LIST_TOOL,
-    SITE_DNS_TYPE_A_RECORD_CREATE_TOOL,
-    SITE_DNS_CNAME_DOMAIN_RECORD_CREATE_TOOL,
+    SITE_DNS_A_RECORD_CREATE_TOOL,
+    SITE_DNS_CNAME_RECORD_CREATE_TOOL,
     SITE_RECORD_LIST_TOOL
 ];
 const ESA_OPENAPI_LIST = [
     ...ESA_OPENAPI_ER_LIST
 ];
 const routineHandlers = {
-    site_dns_type_a_record_create: site_dns_type_a_record_create,
-    site_dns_cname_domain_record_create: site_dns_cname_domain_record_create,
+    site_dns_a_record_create: site_dns_a_record_create,
+    site_dns_cname_record_create: site_dns_cname_record_create,
     site_active_list: site_active_list,
     site_match: site_match,
     site_route_list: site_route_list,

package/dist/index.mjs

@@ -251,7 +251,7 @@ class Client {
 const service = new Client();
 const ROUTINE_CODE_COMMIT_TOOL = {
     name: 'routine_code_commit',
-    description: 'Commit a edge routine(ER) code. If it fails, please submit again.',
+    description: 'Save a code version for future modifications or release within an Edge Routine (ER).',
     inputSchema: {
         type: 'object',
         properties: {
@@ -322,7 +322,7 @@ const routine_code_commit = async (request)=>{
 };
 const ROUTINE_CODE_DEPLOY_TOOL = {
     name: 'routine_code_deploy',
-    description: 'Deploy a routine code, must be a valid semantic version. If version is not exist, should call routine_code_commit first',
+    description: 'Deploy a selected code version to the staging or production environment. If version is not exist, should call routine_code_commit first',
     inputSchema: {
         type: 'object',
         properties: {
@@ -407,7 +407,7 @@ const canary_area_list = async ()=>{
 };
 const DEPLOYMENT_DELETE_TOOL = {
     name: 'deployment_delete',
-    description: 'Delete a deployment',
+    description: 'Delete a specified code version associated with an Edge Routine (ER).',
     inputSchema: {
         type: 'object',
         properties: {
@@ -440,7 +440,7 @@ const deployment_delete = async (request)=>{
 };
 const ER_RECORD_CREATE_TOOL = {
     name: 'er_record_create',
-    description: 'Create a record',
+    description: 'Create a new record associated with an Edge Routine (ER)',
     inputSchema: {
         type: 'object',
         properties: {
@@ -466,7 +466,7 @@ const ER_RECORD_CREATE_TOOL = {
 };
 const ER_RECORD_DELETE_TOOL = {
     name: 'er_record_delete',
-    description: 'Delete a record',
+    description: 'Delete a specified record associated with an Edge Routine (ER).',
     inputSchema: {
         type: 'object',
         properties: {
@@ -496,7 +496,7 @@ const ER_RECORD_DELETE_TOOL = {
 };
 const ER_RECORD_LIST_TOOL = {
     name: 'er_record_list',
-    description: 'List all records',
+    description: 'List all records associated with a specific Edge Routine (ER).',
     inputSchema: {
         type: 'object',
         properties: {
@@ -560,7 +560,7 @@ const er_record_list = async (request)=>{
 };
 const ROUTE_CREATE_TOOL = {
     name: 'route_create',
-    description: 'Create a edge routine(ER) related route',
+    description: 'Create a new route associated with an Edge Routine (ER).',
     inputSchema: {
         type: 'object',
         properties: {
@@ -578,7 +578,7 @@ const ROUTE_CREATE_TOOL = {
             },
             route: {
                 type: 'string',
-                description: 'The route of the route, if mode is simple, this field is required'
+                description: 'The route of the route, if mode is simple, this field is required. For example: test.example.com/*'
             },
             rule: {
                 type: 'string',
@@ -590,7 +590,7 @@ const ROUTE_CREATE_TOOL = {
             },
             routeName: {
                 type: 'string',
-                description: 'The name of the route, use to identify the route'
+                description: 'The name of the route, use to identify the route. For example: test-route'
             },
             bypass: {
                 type: 'enum',
@@ -626,7 +626,7 @@ const ROUTE_CREATE_TOOL = {
 };
 const ROUTE_UPDATE_TOOL = {
     name: 'route_update',
-    description: 'Update a routine related route',
+    description: 'Modify the configuration of an existing Edge Routine route.',
     inputSchema: {
         type: 'object',
         properties: {
@@ -640,7 +640,7 @@ const ROUTE_UPDATE_TOOL = {
             },
             routeName: {
                 type: 'string',
-                description: 'The name of the route, use to identify the route'
+                description: 'The name of the route, use to identify the route.'
             },
             routeEnable: {
                 type: 'enum',
@@ -684,7 +684,7 @@ const ROUTE_UPDATE_TOOL = {
 };
 const ROUTE_DELETE_TOOL = {
     name: 'route_delete',
-    description: 'Delete a routine related route',
+    description: 'Delete a specified route associated with an Edge Routine (ER).',
     inputSchema: {
         type: 'object',
         properties: {
@@ -705,7 +705,7 @@ const ROUTE_DELETE_TOOL = {
 };
 const ROUTE_GET_TOOL = {
     name: 'route_get',
-    description: 'Get a routine related route',
+    description: 'Get details of a specific route associated with an Edge Routine (ER).',
     inputSchema: {
         type: 'object',
         properties: {
@@ -726,7 +726,7 @@ const ROUTE_GET_TOOL = {
 };
 const ROUTINE_ROUTE_LIST_TOOL = {
     name: 'routine_route_list',
-    description: 'List all routes of a routine',
+    description: 'List all routes associated with a specific Edge Routine (ER).',
     inputSchema: {
         type: 'object',
         properties: {
@@ -754,7 +754,7 @@ const ROUTINE_ROUTE_LIST_TOOL = {
 };
 const SITE_ROUTE_LIST_TOOL = {
     name: 'site_route_list',
-    description: 'List all routes of a site',
+    description: 'List all routes associated with a specific site.',
     inputSchema: {
         type: 'object',
         properties: {
@@ -890,7 +890,7 @@ const site_route_list = async (request)=>{
 };
 const ROUTINE_CREATE_TOOL = {
     name: 'routine_create',
-    description: 'Create a edge routine(ER).',
+    description: 'Create a new Edge Routine (ER) in your Alibaba Cloud account.',
     inputSchema: {
         type: 'object',
         properties: {
@@ -915,7 +915,7 @@ const ROUTINE_CREATE_TOOL = {
 };
 const ROUTINE_DELETE_TOOL = {
     name: 'routine_delete',
-    description: 'Delete a edge routine(ER).',
+    description: 'Delete an existing Edge Routine (ER) from your Alibaba Cloud account.',
     inputSchema: {
         type: 'object',
         properties: {
@@ -931,7 +931,7 @@ const ROUTINE_DELETE_TOOL = {
 };
 const ROUTINE_LIST_TOOL = {
     name: 'routine_list',
-    description: 'List all edge routines',
+    description: 'List all Edge Routines (ERs) in your Alibaba Cloud account.',
     inputSchema: {
         type: 'object',
         properties: {}
@@ -939,7 +939,7 @@ const ROUTINE_LIST_TOOL = {
 };
 const ROUTINE_GET_TOOL = {
     name: 'routine_get',
-    description: 'Get a edge routine detail by name',
+    description: 'Get a the details of a Edge Routine (ER).',
     inputSchema: {
         type: 'object',
         properties: {
@@ -1011,7 +1011,7 @@ const SITE_ACTIVE_LIST_TOOL = {
 };
 const SITE_MATCH_TOOL = {
     name: 'site_match',
-    description: 'Check which site under the account matches the user input， user must input recordName',
+    description: 'Identify which site in the account matches the provided input criteria.',
     inputSchema: {
         type: 'object',
         properties: {
@@ -1025,9 +1025,9 @@ const SITE_MATCH_TOOL = {
         ]
     }
 };
-const SITE_DNS_TYPE_A_RECORD_CREATE_TOOL = {
-    name: 'site_dns_type_a_record_create',
-    description: 'Create a A record for a site.',
+const SITE_DNS_A_RECORD_CREATE_TOOL = {
+    name: 'site_dns_a_record_create',
+    description: 'Create an A DNS record for a specified site.',
     inputSchema: {
         type: 'object',
         properties: {
@@ -1067,9 +1067,9 @@ const SITE_DNS_TYPE_A_RECORD_CREATE_TOOL = {
         ]
     }
 };
-const SITE_DNS_CNAME_DOMAIN_RECORD_CREATE_TOOL = {
-    name: 'site_dns_cname_domain_record_create',
-    description: 'Create a CNAME domain record for a site.',
+const SITE_DNS_CNAME_RECORD_CREATE_TOOL = {
+    name: 'site_dns_cname_record_create',
+    description: 'Create a CNAME DNS record for a specified site.',
     inputSchema: {
         type: 'object',
         properties: {
@@ -1111,7 +1111,7 @@ const SITE_DNS_CNAME_DOMAIN_RECORD_CREATE_TOOL = {
 };
 const SITE_RECORD_LIST_TOOL = {
     name: 'site_record_list',
-    description: 'List all records in a site',
+    description: 'List DNS records associated with a specific site.',
     inputSchema: {
         type: 'object',
         properties: {
@@ -1122,7 +1122,7 @@ const SITE_RECORD_LIST_TOOL = {
         }
     }
 };
-const site_dns_type_a_record_create = async (request)=>{
+const site_dns_a_record_create = async (request)=>{
     const res = await service.createRecord({
         ttl: 1,
         proxied: true,
@@ -1140,7 +1140,7 @@ const site_dns_type_a_record_create = async (request)=>{
         success: true
     };
 };
-const site_dns_cname_domain_record_create = async (request)=>{
+const site_dns_cname_record_create = async (request)=>{
     const res = await service.createRecord({
         ttl: 1,
         proxied: true,
@@ -1227,16 +1227,16 @@ const ESA_OPENAPI_ER_LIST = [
     ER_RECORD_CREATE_TOOL,
     ER_RECORD_DELETE_TOOL,
     ER_RECORD_LIST_TOOL,
-    SITE_DNS_TYPE_A_RECORD_CREATE_TOOL,
-    SITE_DNS_CNAME_DOMAIN_RECORD_CREATE_TOOL,
+    SITE_DNS_A_RECORD_CREATE_TOOL,
+    SITE_DNS_CNAME_RECORD_CREATE_TOOL,
     SITE_RECORD_LIST_TOOL
 ];
 const ESA_OPENAPI_LIST = [
     ...ESA_OPENAPI_ER_LIST
 ];
 const routineHandlers = {
-    site_dns_type_a_record_create: site_dns_type_a_record_create,
-    site_dns_cname_domain_record_create: site_dns_cname_domain_record_create,
+    site_dns_a_record_create: site_dns_a_record_create,
+    site_dns_cname_record_create: site_dns_cname_record_create,
     site_active_list: site_active_list,
     site_match: site_match,
     site_route_list: site_route_list,

package/dist/tools/list-esa-function.d.ts

@@ -10,6 +10,14 @@ export declare const ESA_OPENAPI_ER_LIST: {
         } | undefined;
     };
     description?: string | undefined;
+    annotations?: {
+        [x: string]: unknown;
+        title?: string | undefined;
+        readOnlyHint?: boolean | undefined;
+        destructiveHint?: boolean | undefined;
+        idempotentHint?: boolean | undefined;
+        openWorldHint?: boolean | undefined;
+    } | undefined;
 }[];
 export declare const ESA_OPENAPI_LIST: {
     [x: string]: unknown;
@@ -22,5 +30,13 @@ export declare const ESA_OPENAPI_LIST: {
         } | undefined;
     };
     description?: string | undefined;
+    annotations?: {
+        [x: string]: unknown;
+        title?: string | undefined;
+        readOnlyHint?: boolean | undefined;
+        destructiveHint?: boolean | undefined;
+        idempotentHint?: boolean | undefined;
+        openWorldHint?: boolean | undefined;
+    } | undefined;
 }[];
 export declare const routineHandlers: ToolHandlers;

package/dist/tools/site.d.ts

@@ -1,17 +1,17 @@
 import { CallToolRequest, Tool } from '@modelcontextprotocol/sdk/types.js';
 export declare const SITE_ACTIVE_LIST_TOOL: Tool;
 export declare const SITE_MATCH_TOOL: Tool;
-export declare const SITE_DNS_TYPE_A_RECORD_CREATE_TOOL: Tool;
-export declare const SITE_DNS_CNAME_DOMAIN_RECORD_CREATE_TOOL: Tool;
+export declare const SITE_DNS_A_RECORD_CREATE_TOOL: Tool;
+export declare const SITE_DNS_CNAME_RECORD_CREATE_TOOL: Tool;
 export declare const SITE_RECORD_LIST_TOOL: Tool;
-export declare const site_dns_type_a_record_create: (request: CallToolRequest) => Promise<{
+export declare const site_dns_a_record_create: (request: CallToolRequest) => Promise<{
     content: {
         type: string;
         text: string;
     }[];
     success: boolean;
 }>;
-export declare const site_dns_cname_domain_record_create: (request: CallToolRequest) => Promise<{
+export declare const site_dns_cname_record_create: (request: CallToolRequest) => Promise<{
     content: {
         type: string;
         text: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mcp-server-esa",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "Alibaba Cloud ESA (Edge Security Acceleration) MCP Server",
   "main": "./dist/index.js",
   "type": "commonjs",
@@ -35,7 +35,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@alicloud/esa20240910": "^2.23.0",
+    "@alicloud/esa20240910": "^2.25.0",
     "@alicloud/openapi-client": "^0.4.13",
     "@alicloud/tea-util": "^1.4.10",
     "@modelcontextprotocol/sdk": "^1.7.0",