alibaba-cloud-ops-mcp-server 0.7.9__py3-none-any.whl → 0.8.1__py3-none-any.whl

alibaba_cloud_ops_mcp_server/{api_meta_client.py → alibabacloud/api_meta_client.py}

@@ -75,6 +75,10 @@ class ApiMetaClient:
         # 获取POP平台API META参考文档：https://api.aliyun.com/openmeta/guide
         version = cls.get_service_version(service)
         service_standard, api_standard = cls.get_standard_service_and_api(service, api, version)
+        if service_standard is None:
+            raise Exception(f'InvalidServiceName: Please check the Service ({service}) you provide.')
+        if api_standard is None:
+            raise Exception(f'InvalidAPIName: Please check the Service ({service}) and the API ({api}) you provide.')
         data = cls.get_response_from_pop_api(cls.GET_API_INFO, service_standard, api_standard, version)
         return data, version
 

alibaba_cloud_ops_mcp_server/server.py

@@ -1,176 +1,13 @@
-# server.py
-import os
-from mcp.server.fastmcp import FastMCP, Context
-from pydantic import Field
+from mcp.server.fastmcp import FastMCP
 import click
 import logging
 
-import inspect
-import types
-from dataclasses import make_dataclass, field
-from alibabacloud_tea_openapi import models as open_api_models
-from alibabacloud_tea_util import models as util_models
-from alibabacloud_tea_openapi.client import Client as OpenApiClient
-from alibabacloud_openapi_util.client import Client as OpenApiUtilClient
-from alibaba_cloud_ops_mcp_server.api_meta_client import ApiMetaClient
 from alibaba_cloud_ops_mcp_server.config import config
-
-from alibaba_cloud_ops_mcp_server import oos_tools
-from alibaba_cloud_ops_mcp_server import cms_tools
-from alibaba_cloud_ops_mcp_server import oss_tools
+from alibaba_cloud_ops_mcp_server.tools import cms_tools, oos_tools, oss_tools, api_tools
 
 logger = logging.getLogger(__name__)
 
 
-type_map = {
-    'string': str,
-    'integer': int,
-    'boolean': bool,
-    'array': list,
-    'object': dict,
-    'number': float
-}
-
-
-def create_client(service: str, region_id: str) -> OpenApiClient:
-    config = open_api_models.Config(
-        access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
-        access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
-        user_agent='alibaba-cloud-ops-mcp-server',
-    )
-    if isinstance(service, str):
-        service = service.lower()
-    config.endpoint = f'{service}.{region_id}.aliyuncs.com'
-    return OpenApiClient(config)
-
-
-def tools_api_call(service: str, api: str, parameters: dict, ctx: Context):
-    service = service.lower()
-    api_meta, _ = ApiMetaClient.get_api_meta(service, api)
-    version = ApiMetaClient.get_service_version(service)
-    method = 'POST' if api_meta.get('methods', [])[0] == 'post' else 'GET'
-    path = api_meta.get('path', '/')
-    style = ApiMetaClient.get_service_style(service)
-    req = open_api_models.OpenApiRequest(
-        query=OpenApiUtilClient.query(parameters)
-    )
-    params = open_api_models.Params(
-        action=api,
-        version=version,
-        protocol='HTTPS',
-        pathname=path,
-        method=method,
-        auth_type='AK',
-        style=style,
-        req_body_type='formData',
-        body_type='json'
-    )
-    client = create_client(service, parameters.get('RegionId', 'cn-hangzhou'))
-    runtime = util_models.RuntimeOptions()
-    return client.call_api(params, req, runtime)
-
-
-def create_parameter_schema(fields: dict):
-    return make_dataclass("ParameterSchema", [(name, type_, value) for name, (type_, value) in fields.items()])
-
-
-def create_function_schemas(service, api, api_meta):
-    schemas = {}
-    schemas[api] = {}
-    parameters = api_meta['parameters']
-    for parameter in parameters:
-        name = parameter.get('name')
-        # TODO 目前忽略了带'.'的参数
-        if '.' in name:
-            continue
-        schema = parameter.get('schema', '')
-        description = schema.get('description', '')
-        example = schema.get('example', '')
-        type_ = schema.get('type', '')
-        description = f'{description} 请注意，提供参数要严格按照参数的类型和参数示例的提示，如果提到参数为String，且为一个 JSON 数组字符串，应在数组内使用单引号包裹对应的参数以避免转义问题，并在最外侧用双引号包裹以确保其是字符串，否则可能会导致参数解析错误。参数类型: {type_},参数示例：{example}'
-        required = schema.get('required', False)
-        python_type = type_map.get(type_, str)
-        field_info = (
-            python_type,
-            field(
-                default=None,
-                metadata={'description': description, 'required': required}
-            )
-        )
-        schemas[api][name] = field_info
-    if 'RegionId' not in schemas[api]:
-        schemas[api]['RegionId'] = (
-            str,
-            field(
-                default=None,
-                metadata={'description': '地域ID', 'required': False}
-            )
-        )
-    return schemas
-
-
-def create_tool_function_with_signature(service: str, function_name: str, fields: dict, description: str):
-    """
-    Dynamically creates a lambda function with a custom signature based on the provided fields.
-    """
-    parameters = []
-    annotations = {}
-    defaults = {}
-
-    for name, (type_, field_info) in fields.items():
-        field_description = field_info.metadata.get('description', '')
-        is_required = field_info.metadata.get('required', False)
-        default_value = field_info.default if not is_required else ...
-
-        field_default = Field(default=default_value, description=field_description)
-        parameters.append(inspect.Parameter(
-            name=name,
-            kind=inspect.Parameter.POSITIONAL_OR_KEYWORD,
-            default=field_default,
-            annotation=type_
-        ))
-        annotations[name] = type_
-        defaults[name] = field_default
-
-    signature = inspect.Signature(parameters)
-
-    def func_code(*args, **kwargs):
-        bound_args = signature.bind(*args, **kwargs)
-        bound_args.apply_defaults()
-
-        return tools_api_call(
-            service=service,
-            api=function_name,
-            parameters=bound_args.arguments,
-            ctx=None
-        )
-
-    func = types.FunctionType(
-        func_code.__code__,
-        globals(),
-        function_name,
-        None,
-        func_code.__closure__
-    )
-    func.__signature__ = signature
-    func.__annotations__ = annotations
-    func.__defaults__ = tuple(defaults.values())
-    func.__doc__ = description
-
-    return func
-
-
-def create_and_decorate_tool(mcp: FastMCP, service: str, api: str):
-    """Create a tool function for a Lambda function."""
-    api_meta, _ = ApiMetaClient.get_api_meta(service, api)
-    fields = create_function_schemas(service, api, api_meta).get(api, {})
-    description = api_meta.get('summary', '')
-    dynamic_lambda = create_tool_function_with_signature(service, api, fields, description)
-    decorated_function = mcp.tool(name=api)(dynamic_lambda)
-
-    return decorated_function
-
-
 @click.command()
 @click.option(
     "--transport",
@@ -187,9 +24,7 @@ def main(transport: str):
         mcp.add_tool(tool)
     for tool in oss_tools.tools:
         mcp.add_tool(tool)
-    for service_code, apis in config.items():
-        for api_name in apis:
-            create_and_decorate_tool(mcp, service_code, api_name)
+    api_tools.create_api_tools(mcp, config)
 
     # Initialize and run the server
     logger.debug(f'mcp server is running on {transport} mode.')

alibaba_cloud_ops_mcp_server/tools/api_tools.py

@@ -0,0 +1,168 @@
+import os
+from mcp.server.fastmcp import FastMCP, Context
+from pydantic import Field
+import logging
+
+import inspect
+import types
+from dataclasses import make_dataclass, field
+from alibabacloud_tea_openapi import models as open_api_models
+from alibabacloud_tea_util import models as util_models
+from alibabacloud_tea_openapi.client import Client as OpenApiClient
+from alibabacloud_openapi_util.client import Client as OpenApiUtilClient
+from alibaba_cloud_ops_mcp_server.alibabacloud.api_meta_client import ApiMetaClient
+
+
+type_map = {
+    'string': str,
+    'integer': int,
+    'boolean': bool,
+    'array': list,
+    'object': dict,
+    'number': float
+}
+
+
+def create_client(service: str, region_id: str) -> OpenApiClient:
+    config = open_api_models.Config(
+        access_key_id=os.getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
+        access_key_secret=os.getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
+        security_token=os.getenv('ALIBABA_CLOUD_SECURITY_TOKEN'),
+        user_agent='alibaba-cloud-ops-mcp-server',
+    )
+    if isinstance(service, str):
+        service = service.lower()
+    config.endpoint = f'{service}.{region_id}.aliyuncs.com'
+    return OpenApiClient(config)
+
+
+def _tools_api_call(service: str, api: str, parameters: dict, ctx: Context):
+    service = service.lower()
+    api_meta, _ = ApiMetaClient.get_api_meta(service, api)
+    version = ApiMetaClient.get_service_version(service)
+    method = 'POST' if api_meta.get('methods', [])[0] == 'post' else 'GET'
+    path = api_meta.get('path', '/')
+    style = ApiMetaClient.get_service_style(service)
+    req = open_api_models.OpenApiRequest(
+        query=OpenApiUtilClient.query(parameters)
+    )
+    params = open_api_models.Params(
+        action=api,
+        version=version,
+        protocol='HTTPS',
+        pathname=path,
+        method=method,
+        auth_type='AK',
+        style=style,
+        req_body_type='formData',
+        body_type='json'
+    )
+    client = create_client(service, parameters.get('RegionId', 'cn-hangzhou'))
+    runtime = util_models.RuntimeOptions()
+    return client.call_api(params, req, runtime)
+
+
+def _create_parameter_schema(fields: dict):
+    return make_dataclass("ParameterSchema", [(name, type_, value) for name, (type_, value) in fields.items()])
+
+
+def _create_function_schemas(service, api, api_meta):
+    schemas = {}
+    schemas[api] = {}
+    parameters = api_meta.get('parameters', [])
+    for parameter in parameters:
+        name = parameter.get('name')
+        # TODO 目前忽略了带'.'的参数
+        if '.' in name:
+            continue
+        schema = parameter.get('schema', '')
+        description = schema.get('description', '')
+        example = schema.get('example', '')
+        type_ = schema.get('type', '')
+        description = f'{description} 请注意，提供参数要严格按照参数的类型和参数示例的提示，如果提到参数为String，且为一个 JSON 数组字符串，应在数组内使用单引号包裹对应的参数以避免转义问题，并在最外侧用双引号包裹以确保其是字符串，否则可能会导致参数解析错误。参数类型: {type_},参数示例：{example}'
+        required = schema.get('required', False)
+        python_type = type_map.get(type_, str)
+        field_info = (
+            python_type,
+            field(
+                default=None,
+                metadata={'description': description, 'required': required}
+            )
+        )
+        schemas[api][name] = field_info
+    if 'RegionId' not in schemas[api]:
+        schemas[api]['RegionId'] = (
+            str,
+            field(
+                default=None,
+                metadata={'description': '地域ID', 'required': False}
+            )
+        )
+    return schemas
+
+
+def _create_tool_function_with_signature(service: str, function_name: str, fields: dict, description: str):
+    """
+    Dynamically creates a lambda function with a custom signature based on the provided fields.
+    """
+    parameters = []
+    annotations = {}
+    defaults = {}
+
+    for name, (type_, field_info) in fields.items():
+        field_description = field_info.metadata.get('description', '')
+        is_required = field_info.metadata.get('required', False)
+        default_value = field_info.default if not is_required else ...
+
+        field_default = Field(default=default_value, description=field_description)
+        parameters.append(inspect.Parameter(
+            name=name,
+            kind=inspect.Parameter.POSITIONAL_OR_KEYWORD,
+            default=field_default,
+            annotation=type_
+        ))
+        annotations[name] = type_
+        defaults[name] = field_default
+
+    signature = inspect.Signature(parameters)
+
+    def func_code(*args, **kwargs):
+        bound_args = signature.bind(*args, **kwargs)
+        bound_args.apply_defaults()
+
+        return _tools_api_call(
+            service=service,
+            api=function_name,
+            parameters=bound_args.arguments,
+            ctx=None
+        )
+
+    func = types.FunctionType(
+        func_code.__code__,
+        globals(),
+        function_name,
+        None,
+        func_code.__closure__
+    )
+    func.__signature__ = signature
+    func.__annotations__ = annotations
+    func.__defaults__ = tuple(defaults.values())
+    func.__doc__ = description
+
+    return func
+
+
+def _create_and_decorate_tool(mcp: FastMCP, service: str, api: str):
+    """Create a tool function for an AlibabaCloud openapi."""
+    api_meta, _ = ApiMetaClient.get_api_meta(service, api)
+    fields = _create_function_schemas(service, api, api_meta).get(api, {})
+    description = api_meta.get('summary', '')
+    dynamic_lambda = _create_tool_function_with_signature(service, api, fields, description)
+    decorated_function = mcp.tool(name=api)(dynamic_lambda)
+
+    return decorated_function
+
+def create_api_tools(mcp: FastMCP, config:dict):
+    for service_code, apis in config.items():
+        for api_name in apis:
+            _create_and_decorate_tool(mcp, service_code, api_name)

alibaba_cloud_ops_mcp_server/{cms_tools.py → tools/cms_tools.py}

@@ -15,10 +15,12 @@ END_STATUSES = ['Success', 'Failed', 'Cancelled']
 
 tools = []
 
+
 def create_client(region_id: str) -> cms20190101Client:
     config = open_api_models.Config(
-        access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
-        access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
+        access_key_id=os.getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
+        access_key_secret=os.getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
+        security_token=os.getenv('ALIBABA_CLOUD_SECURITY_TOKEN'),
         user_agent='alibaba-cloud-ops-mcp-server',
     )
     config.endpoint = f'metrics.{region_id}.aliyuncs.com'

alibaba_cloud_ops_mcp_server/{oos_tools.py → tools/oos_tools.py}

@@ -7,8 +7,6 @@ import time
 from alibabacloud_oos20190601.client import Client as oos20190601Client
 from alibabacloud_tea_openapi import models as open_api_models
 from alibabacloud_oos20190601 import models as oos_20190601_models
-from alibabacloud_tea_util import models as util_models
-from alibabacloud_tea_util.client import Client as UtilClient
 
 
 END_STATUSES = ['Success', 'Failed', 'Cancelled']
@@ -18,8 +16,9 @@ tools = []
 
 def create_client(region_id: str) -> oos20190601Client:
     config = open_api_models.Config(
-        access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
-        access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
+        access_key_id=os.getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
+        access_key_secret=os.getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
+        security_token=os.getenv('ALIBABA_CLOUD_SECURITY_TOKEN'),
         user_agent='alibaba-cloud-ops-mcp-server',
     )
     config.endpoint = f'oos.{region_id}.aliyuncs.com'

alibaba_cloud_ops_mcp_server/{oss_tools.py → tools/oss_tools.py}

@@ -13,8 +13,8 @@ tools = []
 class CredentialsProvider(EnvironmentVariableCredentialsProvider):
     def __init__(self) -> None:
         super().__init__()
-        access_key_id = os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']
-        access_key_secret = os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
+        access_key_id = os.getenv('ALIBABA_CLOUD_ACCESS_KEY_ID')
+        access_key_secret = os.getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET')
         session_token = os.getenv('ALIBABA_CLOUD_SESSION_TOKEN', None)
 
         self._credentials = Credentials(

{alibaba_cloud_ops_mcp_server-0.7.9.dist-info → alibaba_cloud_ops_mcp_server-0.8.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: alibaba-cloud-ops-mcp-server
-Version: 0.7.9
+Version: 0.8.1
 Summary: A MCP server for Alibaba Cloud
 Author-email: Zheng Dayu <dayu.zdy@alibaba-inc.com>
 License-File: LICENSE
@@ -14,7 +14,9 @@ Requires-Dist: mcp[cli]>=1.6.0
 Description-Content-Type: text/markdown
 
 # alibaba-cloud-ops-mcp-server
+
 [中文版本](./README_zh.md)
+
 ## Prepare
 
 Install [uv](https://github.com/astral-sh/uv)
@@ -90,8 +92,8 @@ To use `alibaba-cloud-ops-mcp-server` MCP Server with any other MCP Client, you
 
 If you have any questions, please join the [Alibaba Cloud Ops MCP discussion group](https://qr.dingtalk.com/action/joingroup?code=v1,k1,iFxYG4jjLVh1jfmNAkkclji7CN5DSIdT+jvFsLyI60I=&_dt_no_comment=1&origin=11) (DingTalk group: 113455011677) for discussion.
 
-<img src="https://github.com/aliyun/alibaba-cloud-ops-mcp-server/blob/master/image/Alibaba-Cloud-Ops-MCP-User-Group-en.png?raw=true" width="500">
+<img src="https://oos-public-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/alibaba-cloud-ops-mcp-server/Alibaba-Cloud-Ops-MCP-User-Group-en.png" width="500">
 
 ## Know More
 
-- [Alibaba Cloud MCP Server is ready to use out of the box!！](https://developer.aliyun.com/article/1661348)
+- [Alibaba Cloud MCP Server is ready to use out of the box!！](https://developer.aliyun.com/article/1661348)

alibaba_cloud_ops_mcp_server-0.8.1.dist-info/RECORD

@@ -0,0 +1,15 @@
+alibaba_cloud_ops_mcp_server/__init__.py,sha256=BaluUNyRz8Qw-X7Y0ywDezwbkqiSvWlSYn2452XeGcA,213
+alibaba_cloud_ops_mcp_server/config.py,sha256=Nq6AT8bqSVa6zu9xjInaSjFcxA-GC7MLlCsV1q53yO0,514
+alibaba_cloud_ops_mcp_server/server.py,sha256=nwn04rpm68GI3UJ_hQ0E3pny86dJ47Lw1LncQiBIfW8,896
+alibaba_cloud_ops_mcp_server/alibabacloud/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+alibaba_cloud_ops_mcp_server/alibabacloud/api_meta_client.py,sha256=inOmW1no1YsR6_ezOZfgJtzGKo5nRTDufkf2qUTuNOs,7605
+alibaba_cloud_ops_mcp_server/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+alibaba_cloud_ops_mcp_server/tools/api_tools.py,sha256=HMB7-PdBU8qiyok-gtymt83Cs4eGVSNNCubC0nN9NqE,6000
+alibaba_cloud_ops_mcp_server/tools/cms_tools.py,sha256=ZrOgVqd97EGcGy47Uy5Nwsf1Nqu9rLIfxN9SDZ2Wyzs,4529
+alibaba_cloud_ops_mcp_server/tools/oos_tools.py,sha256=8cIhpy61Ca7sT9aMR6rCtY4V1u6oFuLsY51gtVvkkyk,10051
+alibaba_cloud_ops_mcp_server/tools/oss_tools.py,sha256=Fb15QUCnllEh8J9TppUEAoA2fB46FhSihUP3_dSfVRM,4449
+alibaba_cloud_ops_mcp_server-0.8.1.dist-info/METADATA,sha256=4eS0pIQhD_KP5g_js_DoP1-jcf48tFQRDUfsSwQQAnc,4033
+alibaba_cloud_ops_mcp_server-0.8.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+alibaba_cloud_ops_mcp_server-0.8.1.dist-info/entry_points.txt,sha256=ESGAWXKEp184forhs7VzTD4P1AUdZz6vCW6hRUKITGw,83
+alibaba_cloud_ops_mcp_server-0.8.1.dist-info/licenses/LICENSE,sha256=gQgVkp2ttRCjodiPpXZZR-d7JnrYIYNiHk1YDUYgpa4,11331
+alibaba_cloud_ops_mcp_server-0.8.1.dist-info/RECORD,,

alibaba_cloud_ops_mcp_server-0.7.9.dist-info/RECORD

@@ -1,12 +0,0 @@
-alibaba_cloud_ops_mcp_server/__init__.py,sha256=BaluUNyRz8Qw-X7Y0ywDezwbkqiSvWlSYn2452XeGcA,213
-alibaba_cloud_ops_mcp_server/api_meta_client.py,sha256=pxJztmkmcqqI3djECziAIMc3ZxsS8crqSc6AbneOX2I,7315
-alibaba_cloud_ops_mcp_server/cms_tools.py,sha256=5IhPtkHSwqLsy7D3lGznovQ94e-XBy6HBE7qLDMoYaQ,4464
-alibaba_cloud_ops_mcp_server/config.py,sha256=Nq6AT8bqSVa6zu9xjInaSjFcxA-GC7MLlCsV1q53yO0,514
-alibaba_cloud_ops_mcp_server/oos_tools.py,sha256=NDu18_R3SqB-Fv1SpnljV0b2Py6G9HXcoqvbV0MWL7Y,10105
-alibaba_cloud_ops_mcp_server/oss_tools.py,sha256=6d_vacAJllwkr74bsWgle8yMzqb_Xr1CPAIr_htFP-I,4451
-alibaba_cloud_ops_mcp_server/server.py,sha256=9qk122yEAZgzJ9iBTBns90McguU4pQFIgjOPD1CzH8c,6723
-alibaba_cloud_ops_mcp_server-0.7.9.dist-info/METADATA,sha256=KM1S455aPWzv05MyXGMJPzfnmgJqbVXF1L61Kzp6l4A,4023
-alibaba_cloud_ops_mcp_server-0.7.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-alibaba_cloud_ops_mcp_server-0.7.9.dist-info/entry_points.txt,sha256=ESGAWXKEp184forhs7VzTD4P1AUdZz6vCW6hRUKITGw,83
-alibaba_cloud_ops_mcp_server-0.7.9.dist-info/licenses/LICENSE,sha256=gQgVkp2ttRCjodiPpXZZR-d7JnrYIYNiHk1YDUYgpa4,11331
-alibaba_cloud_ops_mcp_server-0.7.9.dist-info/RECORD,,