Merge pull request #2 from zhangzqs/feature/cdn-refresh

add CDN、CI、Schema Checker

Author: YangSen-qn

.github/workflows/ruff.yml

@@ -0,0 +1,8 @@
+name: Ruff
+on: [push, pull_request]
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3

mcp_server/__init__.py

@@ -8,4 +8,4 @@
 logger = logging.getLogger(consts.LOGGER_NAME)
 logger.info("Initializing MCP server package")
 
-__all__ = ['main']
+__all__ = ["main"]

mcp_server/application.py

@@ -19,13 +19,12 @@
 core.load()
 server = Server("mcp-simple-resource")
 
+
 @server.set_logging_level()
 async def set_logging_level(level: LoggingLevel) -> EmptyResult:
     logger.setLevel(level.lower())
     await server.request_context.session.send_log_message(
-        level="warning",
-        data=f"Log level set to {level}",
-        logger="mcp_s3_server"
+        level="warning", data=f"Log level set to {level}", logger="mcp_s3_server"
     )
     return EmptyResult()
 
@@ -38,14 +37,9 @@ async def list_resources(**kwargs) -> list[types.Resource]:
             resource_list.append(result)
     return resource_list
 
+
 @server.read_resource()
 async def read_resource(uri: AnyUrl) -> str:
-    """
-    Read content from an S3 resource and return structured response
-
-    Returns:
-        Dict containing 'contents' list with uri, mimeType, and text for each resource
-    """
     return await resource.read_resource(uri)
 
 
@@ -55,7 +49,5 @@ async def handle_list_tools() -> list[Tool]:
 
 
 @server.call_tool()
-async def fetch_tool(
-        name: str, arguments: dict
-) -> list[types.TextContent | types.ImageContent | types.EmbeddedResource]:
-    return await tools.fetch_tool(name, arguments)
+async def call_tool(name: str, arguments: dict):
+    return await tools.call_tool(name, arguments)

mcp_server/config/config.py

@@ -17,6 +17,7 @@
 # Load environment variables at package initialization
 load_dotenv()
 
+
 @dataclass
 class Config:
     access_key: str
@@ -28,11 +29,11 @@ class Config:
 
 def load_config() -> Config:
     config = Config(
-        access_key=os.getenv(_CONFIG_ENV_KEY_ACCESS_KEY, ''),
-        secret_key=os.getenv(_CONFIG_ENV_KEY_SECRET_KEY, ''),
-        endpoint_url=os.getenv(_CONFIG_ENV_KEY_ENDPOINT_URL, ''),
-        region_name=os.getenv(_CONFIG_ENV_KEY_REGION_NAME, ''),
-        buckets=_get_configured_buckets_from_env()
+        access_key=os.getenv(_CONFIG_ENV_KEY_ACCESS_KEY, ""),
+        secret_key=os.getenv(_CONFIG_ENV_KEY_SECRET_KEY, ""),
+        endpoint_url=os.getenv(_CONFIG_ENV_KEY_ENDPOINT_URL, ""),
+        region_name=os.getenv(_CONFIG_ENV_KEY_REGION_NAME, ""),
+        buckets=_get_configured_buckets_from_env(),
     )
 
     if not config.access_key:
@@ -61,10 +62,11 @@ def load_config() -> Config:
     logger.info(f"Configured      buckets: {config.buckets}")
     return config
 
+
 def _get_configured_buckets_from_env() -> List[str]:
     bucket_list = os.getenv(_CONFIG_ENV_KEY_BUCKETS)
     if bucket_list:
-        buckets = [b.strip() for b in bucket_list.split(',')]
+        buckets = [b.strip() for b in bucket_list.split(",")]
         return buckets
     else:
         return []

mcp_server/consts/consts.py

@@ -1,2 +1 @@
-
 LOGGER_NAME = "qiniu-s3-mcp"

mcp_server/core/__init__.py

@@ -1,15 +1,13 @@
-
-from .storage import loader as storage_loader
-from .media_processing import loader as media_processing_loader
 from ..config import config
+from .storage import load as load_storage
+from .media_processing import load as load_media_processing
+from .cdn import load as load_cdn
 
 
 def load():
     # 加载配置
-    _conf = config.load_config()
-
-    # 存储业务
-    storage_loader.load(_conf)
+    cfg = config.load_config()
 
-    # dora
-    media_processing_loader.load(_conf)
+    load_storage(cfg)  # 存储业务
+    load_cdn(cfg)  # CDN
+    load_media_processing(cfg)  # dora

mcp_server/core/cdn/__init__.py

@@ -0,0 +1,13 @@
+from .tools import register_tools
+from ...config import config
+from .cdn import CDNService
+
+
+def load(cfg: config.Config):
+    cdn = CDNService(cfg)
+    register_tools(cdn)
+
+
+__all__ = [
+    "load",
+]

mcp_server/core/cdn/cdn.py

@@ -0,0 +1,69 @@
+import logging
+
+from qiniu import CdnManager, Auth
+from qiniu.http import ResponseInfo
+from typing import List, Optional, Dict
+from pydantic import BaseModel
+from dataclasses import dataclass
+
+from ...consts import consts
+from ...config import config
+
+logger = logging.getLogger(consts.LOGGER_NAME)
+
+
+@dataclass
+class PrefetchUrlsResult(BaseModel):
+    code: Optional[int] = None
+    error: Optional[str] = None
+    requestId: Optional[str] = None
+    invalidUrls: Optional[List[str]] = None
+    quotaDay: Optional[int] = None
+    surplusDay: Optional[int] = None
+
+
+@dataclass
+class RefreshResult(BaseModel):
+    code: Optional[int] = None
+    error: Optional[str] = None
+    requestId: Optional[str] = None
+    taskIds: Optional[Dict[str, str]] = None
+    invalidUrls: Optional[List[str]] = None
+    invalidDirs: Optional[List[str]] = None
+    urlQuotaDay: Optional[int] = None
+    urlSurplusDay: Optional[int] = None
+    dirQuotaDay: Optional[int] = None
+    dirSurplusDay: Optional[int] = None
+
+
+def _raise_if_resp_error(resp: ResponseInfo):
+    if resp.ok():
+        return
+    raise RuntimeError(f"qiniu response error: {str(resp)}")
+
+
+class CDNService:
+    def __init__(self, cfg: config.Config):
+        auth = Auth(access_key=cfg.access_key, secret_key=cfg.secret_key)
+        self._cdn_manager = CdnManager(auth)
+
+    def prefetch_urls(self, urls: List[str] = []) -> PrefetchUrlsResult:
+        if not urls:
+            raise ValueError("urls is empty")
+        info, resp = self._cdn_manager.prefetch_urls(urls)
+        _raise_if_resp_error(resp)
+        return PrefetchUrlsResult.model_validate(info)
+
+    def refresh(self, urls: List[str] = [], dirs: List[str] = []) -> RefreshResult:
+        if not urls and not dirs:
+            raise ValueError("urls and dirs cannot be empty")
+        info, resp = self._cdn_manager.refresh_urls_and_dirs(urls, dirs)
+        _raise_if_resp_error(resp)
+        return RefreshResult.model_validate(info)
+
+
+__all__ = [
+    "PrefetchUrlsResult",
+    "RefreshResult",
+    "CDNService",
+]

mcp_server/core/cdn/tools.py

@@ -0,0 +1,160 @@
+from .cdn import CDNService
+from ...consts import consts
+from ...tools import tools
+import logging
+from mcp import types
+from typing import Optional, List
+
+logger = logging.getLogger(consts.LOGGER_NAME)
+
+
+def _build_base_list(
+    code: Optional[int],
+    error: Optional[str],
+    request_id: Optional[str],
+) -> List[str]:
+    rets = []
+    if code:
+        rets.append(f"Status Code: {code}")
+    if error:
+        rets.append(f"Message: {error}")
+    if request_id:
+        rets.append(f"RequestID: {request_id}")
+    return rets
+
+
+class _ToolImpl:
+    def __init__(self, cdn: CDNService):
+        self._cdn = cdn
+
+    @tools.tool_meta(
+        types.Tool(
+            name="CDNPrefetchUrls",
+            description="Newly added resources are proactively retrieved by the CDN and stored on its cache nodes in advance. Users simply submit the resource URLs, and the CDN automatically triggers the prefetch process.",
+            inputSchema={
+                "type": "object",
+                "additionalProperties": False,
+                "properties": {
+                    "urls": {
+                        "type": "array",
+                        "description": "List of individual URLs to prefetch (max 60 items). Must be full URLs with protocol, e.g. 'http://example.com/file.zip'",
+                        "items": {
+                            "type": "string",
+                            "format": "uri",
+                            "pattern": "^https?://",
+                            "examples": [
+                                "https://cdn.example.com/images/photo.jpg",
+                                "http://static.example.com/downloads/app.exe",
+                            ],
+                        },
+                        "maxItems": 60,
+                        "minItems": 1,
+                    }
+                },
+                "required": ["urls"],
+            },
+        )
+    )
+    def prefetch_urls(self, **kwargs) -> list[types.TextContent]:
+        ret = self._cdn.prefetch_urls(**kwargs)
+
+        rets = _build_base_list(ret.code, ret.error, ret.requestId)
+        if ret.invalidUrls:
+            rets.append(f"Invalid URLs: {ret.invalidUrls}")
+        if ret.code // 100 == 2:
+            if ret.quotaDay is not None:
+                rets.append(f"Today's prefetch quota: {ret.quotaDay}")
+            if ret.surplusDay is not None:
+                rets.append(f"Today's remaining quota: {ret.surplusDay}")
+
+        return [
+            types.TextContent(
+                type="text",
+                text="\n".join(rets),
+            )
+        ]
+
+    @tools.tool_meta(
+        types.Tool(
+            name="CDNRefresh",
+            description="This function marks resources cached on CDN nodes as expired. When users access these resources again, the CDN nodes will fetch the latest version from the origin server and store them anew.",
+            inputSchema={
+                "type": "object",
+                "additionalProperties": False,  # 不允许出现未定义的属性
+                "properties": {
+                    "urls": {
+                        "type": "array",
+                        "items": {
+                            "type": "string",
+                            "format": "uri",
+                            "pattern": "^https?://",  # 匹配http://或https://开头的URL
+                            "examples": ["http://bar.foo.com/index.html"],
+                        },
+                        "maxItems": 60,
+                        "description": "List of exact URLs to refresh (max 60 items). Must be full URLs with protocol, e.g. 'http://example.com/path/page.html'",
+                    },
+                    "dirs": {
+                        "type": "array",
+                        "items": {
+                            "type": "string",
+                            "pattern": "^https?://.*/(\\*|$)",  # 匹配以http://或https://开头的URL，并以/或者以/*结尾的字符串
+                            "examples": [
+                                "http://bar.foo.com/dir/",
+                                "http://bar.foo.com/images/*",
+                            ],
+                        },
+                        "maxItems": 10,
+                        "description": "List of directory patterns to refresh (max 10 items). Must end with '/' or '/*' to indicate directory scope",
+                    },
+                },
+                "anyOf": [  # 至少有一个是非空数组
+                    {
+                        "required": ["urls"],
+                        "properties": {"urls": {"not": {"maxItems": 0}}},
+                    },
+                    {
+                        "required": ["dirs"],
+                        "properties": {"dirs": {"not": {"maxItems": 0}}},
+                    },
+                ],
+            },
+        )
+    )
+    def refresh(self, **kwargs) -> list[types.TextContent]:
+        ret = self._cdn.refresh(**kwargs)
+        rets = _build_base_list(ret.code, ret.error, ret.requestId)
+        if ret.taskIds is not None:
+            # 这个可能暂时用不到
+            pass
+        if ret.invalidUrls:
+            rets.append(f"Invalid URLs list: {ret.invalidUrls}")
+        if ret.invalidDirs:
+            rets.append(f"Invalid dirs: {ret.invalidDirs}")
+
+        if ret.code // 100 == 2:
+            if ret.urlQuotaDay is not None:
+                rets.append(f"Today's URL refresh quota: {ret.urlQuotaDay}")
+            if ret.urlSurplusDay is not None:
+                rets.append(f"Today's remaining URL refresh quota: {ret.urlSurplusDay}")
+            if ret.dirQuotaDay is not None:
+                rets.append(f"Today's directory refresh quota: {ret.dirQuotaDay}")
+            if ret.dirSurplusDay is not None:
+                rets.append(
+                    f"Today's remaining directory refresh quota: {ret.dirSurplusDay}"
+                )
+        return [
+            types.TextContent(
+                type="text",
+                text="\n".join(rets),
+            )
+        ]
+
+
+def register_tools(cdn: CDNService):
+    tool_impl = _ToolImpl(cdn)
+    tools.auto_register_tools(
+        [
+            tool_impl.refresh,
+            tool_impl.prefetch_urls,
+        ]
+    )

mcp_server/core/media_processing/__init__.py

@@ -0,0 +1,13 @@
+from . import client
+from .tools import register_tools
+from ...config import config
+
+
+def load(cfg: config.Config):
+    cli = client.Client(cfg)
+    register_tools(cli)
+
+
+__all__ = [
+    "load",
+]