@qingflow-tech/qingflow-cli 1.1.56 → 1.1.58

package/src/qingflow_mcp/tools/data_tools.py

@@ -1,284 +0,0 @@
-from __future__ import annotations
-
-from datetime import datetime
-from pathlib import Path
-from typing import Any, Literal, TypedDict
-
-from mcp.server.fastmcp import FastMCP
-
-from ..backend_client import BackendRequestContext
-from ..config import DEFAULT_PROFILE
-from ..errors import QingflowApiError, raise_tool_error
-from ..json_types import JSONObject, JSONValue
-from .base import ToolBase
-from .csv_export import CsvPageFailure, csv_cell, export_csv_pages
-
-
-DATA_PAGE_SIZE = 1000
-DATA_CSV_SHARD_ROWS = 20_000
-DATA_UNBOUNDED_ROW_THRESHOLD = 50_000
-DATA_CSV_TIME_BUDGET_SECONDS = 55.0
-
-DataFilterOperator = Literal[
-    "eq", "ne", "contains", "not_contains", "gt", "gte", "lt", "lte", "in", "not_in"
-]
-DataSortDirection = Literal["asc", "desc"]
-
-
-class DataWhereItem(TypedDict):
-    """数据面筛选项；in/not_in 使用数组，其余操作符使用单值。"""
-
-    field_id: int
-    op: DataFilterOperator
-    value: JSONValue
-
-
-class DataSortItem(TypedDict):
-    """数据面排序项。"""
-
-    field_id: int
-    direction: DataSortDirection
-
-
-class DataInsertItem(TypedDict):
-    """数据面新增项，fields 的键为字符串形式 field_id。"""
-
-    fields: dict[str, JSONValue]
-
-
-class DataTools(ToolBase):
-    """视图无关的应用数据面工具。"""
-
-    def register(self, mcp: FastMCP) -> None:
-        @mcp.tool()
-        def data_query(
-            profile: str = DEFAULT_PROFILE,
-            app_key: str = "",
-            columns: list[int] | None = None,
-            where: list[DataWhereItem] | None = None,
-            sort: list[DataSortItem] | None = None,
-            search: str = "",
-            page: int = 1,
-            page_size: int = 100,
-            include_schema: bool = True,
-            all_pages: bool = False,
-            output: str = "json",
-        ) -> JSONObject:
-            """按字段 ID 查询应用数据；先读取 field_capabilities 再构造 where 和 sort。"""
-            return self.data_query(
-                profile=profile, app_key=app_key, columns=columns or [], where=where or [], sort=sort or [],
-                search=search, page=page, page_size=page_size, include_schema=include_schema,
-                all_pages=all_pages, output=output,
-            )
-
-        @mcp.tool()
-        def data_get(
-            profile: str = DEFAULT_PROFILE, app_key: str = "", record_id: str = "", include_schema: bool = True
-        ) -> JSONObject:
-            return self.data_get(profile=profile, app_key=app_key, record_id=record_id, include_schema=include_schema)
-
-        @mcp.tool()
-        def data_insert(
-            profile: str = DEFAULT_PROFILE, app_key: str = "", items: list[DataInsertItem] | None = None,
-            include_schema: bool = True,
-        ) -> JSONObject:
-            """新增应用数据；每项形如 {"fields": {"字段ID": 值}}。"""
-            return self.data_insert(profile=profile, app_key=app_key, items=items or [], include_schema=include_schema)
-
-        @mcp.tool()
-        def data_update(
-            profile: str = DEFAULT_PROFILE, app_key: str = "", record_id: str = "",
-            fields: dict | None = None, include_schema: bool = True,
-        ) -> JSONObject:
-            return self.data_update(
-                profile=profile, app_key=app_key, record_id=record_id, fields=fields or {},
-                include_schema=include_schema,
-            )
-
-        @mcp.tool()
-        def data_delete(
-            profile: str = DEFAULT_PROFILE, app_key: str = "", record_ids: list[str | int] | None = None,
-        ) -> JSONObject:
-            return self.data_delete(profile=profile, app_key=app_key, record_ids=record_ids or [])
-
-    def data_query(
-        self, *, profile: str, app_key: str, columns: list[int], where: list[DataWhereItem],
-        sort: list[DataSortItem],
-        search: str = "", page: int = 1, page_size: int = 100, include_schema: bool = True,
-        all_pages: bool = False, output: str = "json",
-    ) -> JSONObject:
-        self._require_app_key(app_key)
-        if all_pages and output != "csv":
-            raise_tool_error(QingflowApiError.config_error("all_pages 仅支持 output=csv"))
-
-        def runner(session_profile, context):
-            body: JSONObject = {
-                "page": page, "page_size": page_size, "columns": columns, "where": where, "sort": sort,
-                "search": search, "include_schema": include_schema,
-            }
-            if not all_pages:
-                return self._attach_context(
-                    self._request_data_plane(context, "POST", self._base_path(app_key) + "/query", json_body=body),
-                    profile, session_profile.selected_ws_id,
-                )
-            return self._export_all(
-                context=context, profile=profile, ws_id=session_profile.selected_ws_id, app_key=app_key,
-                body=body, has_scope=bool(where or search),
-            )
-
-        return self._run(profile, runner, tool_name="数据面查询")
-
-    def data_get(self, *, profile: str, app_key: str, record_id: str | int, include_schema: bool = True) -> JSONObject:
-        self._require_app_key(app_key)
-        self._require_record_id(record_id)
-        return self._run(
-            profile,
-            lambda session_profile, context: self._attach_context(
-                self._request_data_plane(
-                    context, "GET", f"{self._base_path(app_key)}/{record_id}",
-                    params={"include_schema": include_schema},
-                ), profile, session_profile.selected_ws_id,
-            ),
-            tool_name="数据面单条读取",
-        )
-
-    def data_insert(
-        self, *, profile: str, app_key: str, items: list[DataInsertItem], include_schema: bool = True
-    ) -> JSONObject:
-        self._require_app_key(app_key)
-        return self._write(profile, app_key, "POST", self._base_path(app_key), {"items": items, "include_schema": include_schema}, "数据面新增")
-
-    def data_update(
-        self, *, profile: str, app_key: str, record_id: str | int, fields: dict, include_schema: bool = True
-    ) -> JSONObject:
-        self._require_app_key(app_key)
-        self._require_record_id(record_id)
-        return self._write(
-            profile, app_key, "POST", f"{self._base_path(app_key)}/{record_id}/update",
-            {"fields": fields, "include_schema": include_schema}, "数据面更新",
-        )
-
-    def data_delete(self, *, profile: str, app_key: str, record_ids: list[str | int]) -> JSONObject:
-        self._require_app_key(app_key)
-        return self._write(profile, app_key, "POST", self._base_path(app_key) + "/delete", {"record_ids": record_ids}, "数据面删除")
-
-    def _write(self, profile: str, app_key: str, method: str, path: str, body: JSONObject, tool_name: str) -> JSONObject:
-        return self._run(
-            profile,
-            lambda session_profile, context: self._attach_context(
-                self._request_data_plane(context, method, path, json_body=body), profile, session_profile.selected_ws_id,
-            ),
-            tool_name=tool_name,
-        )
-
-    def _request_data_plane(
-        self, context: BackendRequestContext, method: str, path: str, *, params: JSONObject | None = None,
-        json_body: JSONValue = None,
-    ) -> JSONObject:
-        raw = self.backend.request(method, context, path, params=params, json_body=json_body, unwrap=False)
-        if not isinstance(raw, dict):
-            raise QingflowApiError(category="backend", message="数据面返回了非对象响应")
-        code = raw.get("code")
-        payload = raw.get("data")
-        result: JSONObject = dict(payload) if isinstance(payload, dict) else {}
-        success = code in (None, 0, 200, 20000) or str(code).lower() in {"success", "ok"}
-        result.setdefault("ok", success)
-        result.setdefault("status", "success" if success else "failed")
-        result.setdefault("hints", [])
-        if not success:
-            result.setdefault("message", str(raw.get("message") or raw.get("msg") or "数据面请求失败"))
-            result.setdefault("backend_code", code)
-        return result
-
-    def _export_all(
-        self, *, context: BackendRequestContext, profile: str, ws_id: int | None, app_key: str,
-        body: JSONObject, has_scope: bool,
-    ) -> JSONObject:
-        probe_body = dict(body)
-        probe_body.update({"page": 1, "page_size": 1, "include_schema": True})
-        probe = self._request_data_plane(context, "POST", self._base_path(app_key) + "/query", json_body=probe_body)
-        if probe.get("ok") is False:
-            # 探测请求没有产生文件，保留后端结构化错误，不把失败误报为空数据成功。
-            return self._attach_context(probe, profile, ws_id)
-        records = probe.get("records") if isinstance(probe.get("records"), dict) else {}
-        total = records.get("total") if isinstance(records, dict) else None
-        if isinstance(total, int) and total > DATA_UNBOUNDED_ROW_THRESHOLD and not has_scope:
-            return self._attach_context({
-                "ok": True, "status": "needs_scope", "app_key": app_key, "format": "csv", "row_count": 0,
-                "complete": False, "truncated": True, "safe_for_final_conclusion": False, "files": [],
-                "hints": probe.get("hints", []),
-                "schema": probe.get("schema", {}),
-                "field_capabilities": probe.get("field_capabilities", []),
-                "scope": {"reported_total": total, "row_threshold": DATA_UNBOUNDED_ROW_THRESHOLD},
-            }, profile, ws_id)
-        schema = probe.get("schema") if isinstance(probe.get("schema"), dict) else {}
-        fields = schema.get("fields") if isinstance(schema, dict) else None
-        field_list = fields if isinstance(fields, list) else []
-        business_fields = [field for field in field_list if isinstance(field, dict) and field.get("field_id") is not None]
-        columns = [(str(field.get("field_id")), str(field.get("title") or field.get("field_id"))) for field in business_fields]
-        header = ["record_id"] + [f"{title}__field_{field_id}" for field_id, title in columns]
-        run_dir = Path.home() / ".qingflow" / "data-exports" / datetime.now().strftime("%Y%m%d-%H%M%S-%f")
-        latest_hints = probe.get("hints", [])
-        latest_schema = schema
-        latest_capabilities = probe.get("field_capabilities", [])
-
-        def fetch_page(page: int, page_size: int) -> JSONObject:
-            nonlocal latest_hints, latest_schema, latest_capabilities
-            request_body = dict(body)
-            # 每页都请求 schema，使最后一页的后端原始 hints 同时准确表达完整性和字段能力。
-            request_body.update({"page": page, "page_size": page_size, "include_schema": True})
-            response = self._request_data_plane(
-                context, "POST", self._base_path(app_key) + "/query", json_body=request_body
-            )
-            if response.get("ok") is False:
-                raise CsvPageFailure(response)
-            latest_hints = response.get("hints", [])
-            if isinstance(response.get("schema"), dict):
-                latest_schema = response["schema"]
-            if isinstance(response.get("field_capabilities"), list):
-                latest_capabilities = response["field_capabilities"]
-            return response
-
-        def project_row(record: JSONObject) -> list[str]:
-            values = record.get("fields") if isinstance(record.get("fields"), dict) else record
-            return [str(record.get("record_id") or "")] + [csv_cell(values.get(field_id)) for field_id, _ in columns]
-
-        exported = export_csv_pages(
-            fetch_page=fetch_page, header=header, project_row=project_row, output_dir=run_dir,
-            file_prefix="records", page_size=DATA_PAGE_SIZE, shard_rows=DATA_CSV_SHARD_ROWS,
-            time_budget_seconds=DATA_CSV_TIME_BUDGET_SECONDS,
-        )
-        page_error = exported.pop("page_error", None)
-        result: JSONObject = {
-            "ok": True, "status": "success" if exported["complete"] else "partial", "app_key": app_key,
-            "format": "csv", "local_dir": str(run_dir), "fields": business_fields,
-            "schema": latest_schema, "field_capabilities": latest_capabilities, "hints": latest_hints,
-            **exported,
-        }
-        if isinstance(page_error, dict):
-            # 后续页失败时保留已落盘分片，同时把后端稳定错误字段原样带回。
-            result["ok"] = False
-            for key in ("error_code", "message", "backend_code", "write_executed", "retry_safe", "field_errors"):
-                if key in page_error:
-                    result[key] = page_error[key]
-            if "hints" in page_error:
-                result["hints"] = page_error["hints"]
-        return self._attach_context(result, profile, ws_id)
-
-    @staticmethod
-    def _base_path(app_key: str) -> str:
-        return f"/app/{app_key}/data/v1/records"
-
-    @staticmethod
-    def _attach_context(result: JSONObject, profile: str, ws_id: int | None) -> JSONObject:
-        return {"profile": profile, "ws_id": ws_id, **result}
-
-    @staticmethod
-    def _require_app_key(app_key: str) -> None:
-        if not str(app_key or "").strip():
-            raise_tool_error(QingflowApiError.config_error("app_key is required"))
-
-    @staticmethod
-    def _require_record_id(record_id: str | int) -> None:
-        if not str(record_id or "").strip():
-            raise_tool_error(QingflowApiError.config_error("record_id is required"))