escloud-mcp-server 0.0.1__py3-none-any.whl

escloud_mcp_server/__init__.py

@@ -0,0 +1,8 @@
+from escloud_mcp_server import server
+
+
+def main():
+    """
+    Main entry point for the package.
+    """
+    server.main()

escloud_mcp_server/__main__.py

@@ -0,0 +1,3 @@
+if __name__ == "__main__":
+    from escloud_mcp_server import main
+    main()

escloud_mcp_server/client.py

@@ -0,0 +1,22 @@
+import os
+import volcenginesdkcore
+import volcenginesdkescloud
+from dotenv import load_dotenv
+
+
+def create_escloud_client(region_id: str) -> volcenginesdkescloud.ESCLOUDApi:
+    """创建火山引擎云搜索服务客户端"""
+    load_dotenv()
+    config = {
+        "ak": os.getenv("VOLC_ACCESS_KEY"),
+        "sk": os.getenv("VOLC_SECRET_KEY"),
+    }
+    if region_id is not None:
+        config["region"] = region_id
+
+    configuration = volcenginesdkcore.Configuration()
+    configuration.ak = config["ak"]
+    configuration.sk = config["sk"]
+    configuration.region = config["region"]
+    configuration.client_side_validation = True
+    return volcenginesdkescloud.ESCLOUDApi(volcenginesdkcore.ApiClient(configuration))

escloud_mcp_server/server.py

@@ -0,0 +1,29 @@
+from mcp.server.fastmcp import FastMCP
+
+from escloud_mcp_server.tools import instance_info, resource_info
+
+
+class ESCloudMCPServer:
+    def __init__(self):
+        self.name = "ESCloudMCPServer"
+        self.mcp = FastMCP(self.name)
+        self._register_tools()
+
+    def _register_tools(self):
+        """Register tools to the mcp server."""
+        resource_info.register_tools(self.mcp)
+        instance_info.register_tools(self.mcp)
+
+    def run(self):
+        """Run the mcp server."""
+        self.mcp.run(transport="stdio")
+
+
+def main():
+    server = ESCloudMCPServer()
+    server.run()
+
+
+if __name__ == "__main__":
+    print("Start ESCloud MCP Server")
+    main()

escloud_mcp_server/tools/instance_info.py

@@ -0,0 +1,117 @@
+import volcenginesdkescloud
+from mcp.server.fastmcp import FastMCP
+from mcp.types import TextContent
+
+from escloud_mcp_server.client import create_escloud_client
+
+
+def register_tools(mcp: FastMCP):
+    @mcp.tool()
+    async def escloud_describe_instance(region_id: str, instance_id: str):
+        """
+        查询云搜索服务在指定区域下的实例详细信息，包括实例 id、名称、版本、状态、创建时间、计费类型、规格配置、标签列表、网络配置、数据迁移等信息。
+
+        :param region_id: 区域 id
+        :param instance_id: 实例 id
+        :return: 实例详细信息
+        """
+        try:
+            client = create_escloud_client(region_id)
+            response = client.describe_instance(
+                volcenginesdkescloud.DescribeInstanceRequest(instance_id=instance_id)
+            )
+            return TextContent(type="text", text=str(response))
+        except Exception as e:
+            return TextContent(type="text", text=f"Error: {str(e)}")
+
+    @mcp.tool()
+    async def escloud_describe_instances(region_id: str, zone_id=None, instance_id=None, instance_name=None,
+                                 status=None, version=None, charge_type=None, project_name=None,
+                                 page_number=1, page_size=10):
+        """
+        查询云搜索服务在指定区域下的实例列表，包括每个实例的详细信息。
+
+        :param region_id: 区域 id
+        :param zone_id: 可用区 id，支持模糊查询
+        :param instance_id: 实例 id，支持模糊查询
+        :param instance_name: 实例名称，支持模糊查询
+        :param status: 实例状态
+        :param version: 实例版本
+        :param charge_type: 实例计费类型
+        :param project_name: 项目名称
+        :param page_number: 分页页码
+        :param page_size: 分页大小
+        :return: 实例列表
+        """
+        try:
+            filters = []
+            if zone_id:
+                filters.append(
+                    volcenginesdkescloud.FilterForDescribeInstancesInput(name="ZoneId", values=[zone_id])
+                )
+            if instance_id:
+                filters.append(
+                    volcenginesdkescloud.FilterForDescribeInstancesInput(name="InstanceId", values=[instance_id])
+                )
+            if instance_name:
+                filters.append(
+                    volcenginesdkescloud.FilterForDescribeInstancesInput(name="InstanceName", values=[instance_name])
+                )
+            if status:
+                filters.append(
+                    volcenginesdkescloud.FilterForDescribeInstancesInput(name="Status", values=[status])
+                )
+            if version:
+                filters.append(
+                    volcenginesdkescloud.FilterForDescribeInstancesInput(name="Version", values=[version])
+                )
+            if charge_type:
+                filters.append(
+                    volcenginesdkescloud.FilterForDescribeInstancesInput(name="ChargeType", values=[charge_type])
+                )
+
+            client = create_escloud_client(region_id)
+            response = client.describe_instances(volcenginesdkescloud.DescribeInstancesRequest(
+                filters=filters,
+                project_name=project_name,
+                page_number=page_number,
+                page_size=page_size))
+            return TextContent(type="text", text=str(response))
+        except Exception as e:
+            return TextContent(type="text", text=f"Error: {str(e)}")
+
+    @mcp.tool()
+    async def escloud_describe_instance_nodes(region_id: str, instance_id: str):
+        """
+        查询云搜索服务在指定区域下的实例节点列表，包括每个节点的名称、类型、状态、存储配置、规格配置、重启次数等信息。
+
+        :param region_id: 区域 id
+        :param instance_id: 实例 id
+        :return: 实例节点列表
+        """
+        try:
+            client = create_escloud_client(region_id)
+            response = client.describe_instance_nodes(
+                volcenginesdkescloud.DescribeInstanceNodesRequest(instance_id=instance_id)
+            )
+            return TextContent(type="text", text=str(response))
+        except Exception as e:
+            return TextContent(type="text", text=f"Error: {str(e)}")
+
+    @mcp.tool()
+    async def escloud_describe_instance_plugins(region_id: str, instance_id: str):
+        """
+        查询云搜索服务在指定区域下的实例的插件列表，包括每个插件的名称、版本、状态、描述等信息。
+
+        :param region_id: 区域 id
+        :param instance_id: 实例 id
+        :return: 实例插件列表
+        """
+        try:
+            client = create_escloud_client(region_id)
+            response = client.describe_instance_plugins(
+                volcenginesdkescloud.DescribeInstancePluginsRequest(instance_id=instance_id)
+            )
+            return TextContent(type="text", text=str(response))
+        except Exception as e:
+            return TextContent(type="text", text=f"Error: {str(e)}")

escloud_mcp_server/tools/resource_info.py

@@ -0,0 +1,24 @@
+import volcenginesdkescloud
+from mcp.server.fastmcp import FastMCP
+from mcp.types import TextContent
+
+from escloud_mcp_server.client import create_escloud_client
+
+
+def register_tools(mcp: FastMCP):
+    @mcp.tool()
+    async def escloud_describe_zones(region_id: str):
+        """
+        查询云搜索服务在指定区域下的可用区列表，包括可用区 id、名称、状态等信息。
+
+        :param region_id: 区域 id
+        :return: 可用区列表
+        """
+        try:
+            client = create_escloud_client(region_id)
+            response = client.describe_zones(
+                volcenginesdkescloud.DescribeZonesRequest()
+            )
+            return TextContent(type="text", text=str(response))
+        except Exception as e:
+            return TextContent(type="text", text=f"Error: {str(e)}")

escloud_mcp_server-0.0.1.dist-info/METADATA

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: escloud-mcp-server
+Version: 0.0.1
+Summary: ESCloud MCP Server
+License-Expression: MIT
+Requires-Python: >=3.10
+Requires-Dist: mcp[cli]>=1.6.0
+Requires-Dist: volcengine-python-sdk>=1.1.3
+Description-Content-Type: text/markdown
+
+# ESCloud MCP Server
+This mcp server is used to provide interaction with escloud service on volcengine platform. It is a Model 
+Control Protocol([MCP](https://modelcontextprotocol.io/introduction)) server implementation. This server enables 
+querying the available zones in specific region, getting the config, nodes, plugins of instance, and more.
+
+## Prerequisites
+Before using this mcp server, you need to install the following components:
+- ak/sk for volcano engine
+- python 3.10+ or higher
+- [uv](https://github.com/astral-sh/uv) installed
+
+## Usage
+Obtain ak/sk from the [volcengine](https://www.volcengine.com/): login -> right top user icon -> api access secret key.
+
+### Usage with Trae
+TODO
+
+
+### Usage with Cline
+#### Using uvx with published package
+First, adding the following code to the config file `cline_mcp_settings.json`, it will automatically download the
+latest published package from the registry and run it. Then you need to change `your_volcengine_ak` 
+and `your_volcengine_sk` to your ak and sk.
+```json
+{
+  "mcpServers": {
+    "escloud-mcp-server": {
+      "disabled": false,
+      "timeout": 60,
+      "command": "uvx",
+      "args": [
+        "escloud-mcp-server"
+      ],
+      "env": {
+        "VOLC_ACCESS_KEY": "your_volcengine_ak",
+        "VOLC_SECRET_KEY": "your_volcengine_sk"
+      },
+      "transportType": "stdio"
+    }
+  }
+}
+```
+
+#### Using uv with local development
+First, cloning the repository locally and specifying the path to source code. Then add the following code to
+the config file `cline_mcp_settings.json`. Last you need to change `path/to/src/escloud_mcp_server` to the path
+where you cloned the repository, and change `your_volcengine_ak` and `your_volcengine_sk` to your ak and sk.
+```json
+{
+  "mcpServers": {
+    "escloud-mcp-server": {
+      "disabled": false,
+      "timeout": 60,
+      "command": "uv",
+      "args": [
+        "--directory",
+        "path/to/src/escloud_mcp_server",
+        "run",
+        "server.py"
+      ],
+      "env": {
+        "VOLC_ACCESS_KEY": "your_volcengine_ak",
+        "VOLC_SECRET_KEY": "your_volcengine_sk"
+      },
+      "transportType": "stdio"
+    }
+  }
+}
+```
+
+## Tools
+The server provides the following tools:
+- `escloud_describe_zones`: query available zones in a specific region
+  - parameters:
+    - `region_id`: the id of region
+- `escloud_describe_instance`: query the information of a instance
+  - parameters:
+    - `region_id`: the id of region
+    - `instance_id`: the id of instance
+- `escloud_describe_instances`: query the information of instances
+  - parameters:
+    - `region_id`: the id of region
+    - `zone_id`: the id of zone, support fuzzy query
+    - `instance_id`: the id of instance, support fuzzy query
+    - `instance_name`: the name of instance, support fuzzy query
+    - `status`: the status of instance
+    - `version`: the version of instance
+    - `charge_type`: the charge type of instance
+    - `project_name`: the project name that instance belongs to
+    - `page_number`: the page number of the result list
+    - `page_size`: the page size of the result list
+- `escloud_describe_instance_nodes`: query the nodes of a instance
+  - parameters:
+    - `region_id`: the id of region
+    - `instance_id`: the id of instance
+- `escloud_describe_instance_plugins`: query the plugins of a instance
+  - parameters:
+    - `region_id`: the id of region
+    - `instance_id`: the id of instance

escloud_mcp_server-0.0.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+escloud_mcp_server/__init__.py,sha256=69hwKmYrDznN3ln0htzBSzI0PTXe8fm07tVpfr3jmeo,124
+escloud_mcp_server/__main__.py,sha256=HMV50m6yPKI3bZflFYhmg5V9fhL4vlX4wDwFNRJiIL0,78
+escloud_mcp_server/client.py,sha256=oLbwcdxoHKLOvGcAvnXZbE2zNu1pG5r_L2uFfDxk9rk,727
+escloud_mcp_server/server.py,sha256=bK2A0XJykV-DI1HnijjoMiK2Jz5cxPioLEE9Uj8wet0,673
+escloud_mcp_server/tools/instance_info.py,sha256=gq1i-UPopJIyaOyHd9FeDUclbW1ggNEepC9QsXJ_OFk,5119
+escloud_mcp_server/tools/resource_info.py,sha256=wA4iV7M7VIpnSBPsf332PFGLFRpv7hzxq_AF349j6ks,829
+escloud_mcp_server-0.0.1.dist-info/METADATA,sha256=2fKzJcL7xCVIBPFy-gum-2wxLx4iBQePYyjGo6orDow,3662
+escloud_mcp_server-0.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+escloud_mcp_server-0.0.1.dist-info/entry_points.txt,sha256=py-13ItyIEF0rGuplu7Ll1HLY0-FM30LaoXsprwyeDk,66
+escloud_mcp_server-0.0.1.dist-info/RECORD,,

escloud_mcp_server-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

escloud_mcp_server-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+mcp-server-opensearch = escloud_mcp_server:main