mirror of
https://github.com/arsvendg/Stirling-PDF.git
synced 2026-07-14 10:34:06 +02:00
Adds an optional MCP server (proprietary module) that exposes Stirling's PDF operations and AI capabilities to MCP clients. Off by default, zero footprint when disabled. ### What - New `/mcp` endpoint: streamable-HTTP + JSON-RPC 2.0; 8 tools (describe_operation, pages/convert/misc/security category tools, AI, upload, download). - Runs real operations over an internal loopback; results returned inline as base64 (small) or by fileId (large). ### Auth (two modes) - OAuth2 resource server: RFC 9728 protected-resource metadata, RFC 8707 audience binding, JWKS, `mcp.tools.read/write` scopes; binds each token to a provisioned Stirling account. - API-key mode: reuses Stirling per-user `X-API-KEY` (no IdP needed). ### Security - Per-user file ownership in FileStorage: async/queued writes scoped to the submitting user; legacy/owner-less files stay readable. - Admin allow/block list controls which operations are exposed. - Python engine gated behind a shared secret (`X-Engine-Auth`). - MCP filter chain is isolated and cannot weaken the main app's security. - Hardened: no upstream error-body leakage, log injection sanitized, fileId path/sidecar enumeration blocked. ### Config / footprint - Disabled by default (`mcp.enabled=false`); all beans `@ConditionalOnProperty`. --- ## Checklist ### General - [ ] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md) (if applicable) - [ ] I have performed a self-review of my own code - [ ] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### Translations (if applicable) - [ ] I ran [`scripts/counter_translation.py`](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/docs/counter_translation.md) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have run `task check` to verify linters, typechecks, and tests pass - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#7-testing) for more details.
139 lines
4.8 KiB
Python
139 lines
4.8 KiB
Python
from __future__ import annotations
|
|
|
|
import asyncio
|
|
import logging
|
|
from contextlib import asynccontextmanager
|
|
from typing import Annotated
|
|
|
|
from fastapi import Depends, FastAPI
|
|
from pydantic_ai import Agent
|
|
from pydantic_ai.models.instrumented import InstrumentationSettings
|
|
|
|
from stirling.agents import (
|
|
ExecutionPlanningAgent,
|
|
OrchestratorAgent,
|
|
PdfEditAgent,
|
|
PdfQuestionAgent,
|
|
UserSpecAgent,
|
|
)
|
|
from stirling.agents.ledger import MathAuditorAgent
|
|
from stirling.agents.pdf_comment import PdfCommentAgent
|
|
from stirling.api.engine_auth import EngineSharedSecretMiddleware
|
|
from stirling.api.middleware import UserIdMiddleware
|
|
from stirling.api.routes import (
|
|
agent_capabilities_router,
|
|
agent_draft_router,
|
|
document_router,
|
|
execution_router,
|
|
ledger_router,
|
|
orchestrator_router,
|
|
pdf_comments_router,
|
|
pdf_edit_router,
|
|
pdf_question_router,
|
|
)
|
|
from stirling.config import AppSettings, load_settings
|
|
from stirling.contracts import HealthResponse
|
|
from stirling.documents import DocumentService
|
|
from stirling.services import build_runtime, setup_posthog_tracking
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
async def _run_expired_doc_reaper(
|
|
documents: DocumentService,
|
|
interval_seconds: int,
|
|
) -> None:
|
|
"""Periodically delete documents whose ``expires_at`` has passed.
|
|
|
|
A reaped collection drops everything rooted at that document. Backstop
|
|
for the explicit logout purge: catches sessions that ended without a
|
|
clean logout (tab close, JWT expiry, engine restart). Persistent rows
|
|
(``expires_at`` null, the shape we use for org-shared docs) are never
|
|
touched. Runs until cancelled by the lifespan teardown.
|
|
"""
|
|
await _reap(documents)
|
|
while True:
|
|
await asyncio.sleep(interval_seconds)
|
|
await _reap(documents)
|
|
|
|
|
|
async def _reap(documents: DocumentService) -> None:
|
|
"""One reaper iteration. Logs the deleted count on success and the full
|
|
exception with traceback on failure; never re-raises non-cancel errors so
|
|
a bad iteration doesn't kill the loop. ``asyncio.CancelledError`` is
|
|
re-raised so the lifespan teardown can cancel the task cleanly.
|
|
"""
|
|
try:
|
|
deleted = await documents.reap_expired()
|
|
if deleted:
|
|
logger.info("Reaped %d expired document collection(s)", deleted)
|
|
except asyncio.CancelledError:
|
|
raise
|
|
except Exception:
|
|
logger.exception("Document reaper iteration failed; will retry on next interval")
|
|
|
|
|
|
def _load_startup_settings(fast_api: FastAPI) -> AppSettings:
|
|
override = fast_api.dependency_overrides.get(load_settings)
|
|
if override is not None:
|
|
return override()
|
|
return load_settings()
|
|
|
|
|
|
@asynccontextmanager
|
|
async def lifespan(fast_api: FastAPI):
|
|
# Load env vars on startup so we can immediately crash if required env vars aren't set
|
|
settings = _load_startup_settings(fast_api)
|
|
runtime = build_runtime(settings)
|
|
fast_api.state.settings = settings
|
|
fast_api.state.runtime = runtime
|
|
fast_api.state.orchestrator_agent = OrchestratorAgent(runtime)
|
|
fast_api.state.pdf_edit_agent = PdfEditAgent(runtime)
|
|
fast_api.state.pdf_question_agent = PdfQuestionAgent(runtime)
|
|
fast_api.state.user_spec_agent = UserSpecAgent(runtime)
|
|
fast_api.state.execution_planning_agent = ExecutionPlanningAgent(runtime)
|
|
fast_api.state.math_auditor_agent = MathAuditorAgent(runtime)
|
|
fast_api.state.pdf_comment_agent = PdfCommentAgent(runtime)
|
|
tracer_provider = setup_posthog_tracking(settings)
|
|
if tracer_provider:
|
|
Agent.instrument_all(InstrumentationSettings(tracer_provider=tracer_provider))
|
|
reaper_task = asyncio.create_task(
|
|
_run_expired_doc_reaper(
|
|
runtime.documents,
|
|
interval_seconds=settings.documents_reaper_interval_seconds,
|
|
),
|
|
name="expired-document-reaper",
|
|
)
|
|
yield
|
|
reaper_task.cancel()
|
|
try:
|
|
await reaper_task
|
|
except asyncio.CancelledError:
|
|
pass
|
|
await runtime.documents.close()
|
|
if tracer_provider:
|
|
tracer_provider.shutdown()
|
|
|
|
|
|
app = FastAPI(title="Stirling AI Engine", lifespan=lifespan, version="0.1.0")
|
|
app.add_middleware(UserIdMiddleware)
|
|
app.add_middleware(EngineSharedSecretMiddleware)
|
|
app.include_router(orchestrator_router)
|
|
app.include_router(pdf_edit_router)
|
|
app.include_router(pdf_question_router)
|
|
app.include_router(agent_draft_router)
|
|
app.include_router(execution_router)
|
|
app.include_router(document_router)
|
|
app.include_router(ledger_router)
|
|
app.include_router(pdf_comments_router)
|
|
app.include_router(agent_capabilities_router)
|
|
|
|
|
|
@app.get("/health", response_model=HealthResponse)
|
|
async def healthcheck(settings: Annotated[AppSettings, Depends(load_settings)]) -> HealthResponse:
|
|
return HealthResponse(
|
|
status="ok",
|
|
smart_model=settings.smart_model_name,
|
|
fast_model=settings.fast_model_name,
|
|
)
|