mirror of
https://github.com/MODSetter/SurfSense.git
synced 2026-07-09 15:58:30 +00:00
116291a3b6
Rename the import package surfsense_mcp -> mcp_server and remove the src/ layer so the project mirrors the backend's shape (project folder != package name, e.g. surfsense_backend/app). Kills the redundant surfsense_mcp/src/surfsense_mcp nesting. Distribution name and console command (surfsense-mcp) are unchanged; only python -m and internal import paths move to mcp_server. Dockerfile CMD updated; no PYTHONPATH added since the editable install already makes the package importable.
57 lines
2 KiB
Python
57 lines
2 KiB
Python
"""Run a SurfSense scraper capability and shape its result.
|
|
|
|
Shared by every platform tool: POST a typed payload to the workspace's scraper
|
|
door and render the returned items as markdown or JSON.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import Any
|
|
|
|
from ...core.client import SurfSenseClient
|
|
from ...core.rendering import ResponseFormat, clip, compact_items, to_json
|
|
from ...core.workspace_context import WorkspaceContext
|
|
|
|
|
|
async def run_scraper(
|
|
client: SurfSenseClient,
|
|
context: WorkspaceContext,
|
|
*,
|
|
platform: str,
|
|
verb: str,
|
|
payload: dict[str, Any],
|
|
workspace: str | None,
|
|
response_format: ResponseFormat,
|
|
) -> str:
|
|
"""Execute one scraper verb for the resolved workspace and render its output."""
|
|
resolved = await context.resolve(workspace)
|
|
body = {key: value for key, value in payload.items() if value is not None}
|
|
result = await client.request(
|
|
"POST", f"/workspaces/{resolved.id}/scrapers/{platform}/{verb}", json=body
|
|
)
|
|
# Inline results are compacted (redundant fields dropped, long fields
|
|
# excerpted) so every item survives the overall clip; the complete output
|
|
# is stored server-side and retrievable with surfsense_get_scraper_run.
|
|
result = compact_items(result)
|
|
if response_format == "json":
|
|
return clip(to_json(result))
|
|
return _render_markdown(platform, verb, resolved.name, result)
|
|
|
|
|
|
def _render_markdown(
|
|
platform: str, verb: str, workspace_name: str, result: Any
|
|
) -> str:
|
|
"""A readable header plus the structured payload, clipped to a safe size."""
|
|
header = f'# {platform}.{verb} — {_describe_size(result)} from "{workspace_name}"'
|
|
body = clip(to_json(result))
|
|
footer = (
|
|
"\n\nFields shown as excerpts; use surfsense_get_scraper_run for the "
|
|
"full output."
|
|
)
|
|
return f"{header}\n\n```json\n{body}\n```{footer}"
|
|
|
|
|
|
def _describe_size(result: Any) -> str:
|
|
if isinstance(result, dict) and isinstance(result.get("items"), list):
|
|
return f"{len(result['items'])} item(s)"
|
|
return "result"
|