fix: address third round of review feedback
Add BasicAuthLifespanContext Protocol to make the contract between StdioContext and get_client() explicit and type-safe. Document why mcp.get_context() is required for non-template resources. Add News and Collectives to README Supported Apps table, fix transport default. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 4.6
parent
1af85bc05e
commit
f340380898
@@ -85,13 +85,13 @@ docker compose --profile login-flow up -d # Port 8004
|
|||||||
|
|
||||||
## Key Features
|
## Key Features
|
||||||
|
|
||||||
- **90+ MCP Tools** - Comprehensive API coverage across 8 Nextcloud apps
|
- **110+ MCP Tools** - Comprehensive API coverage across 10 Nextcloud apps
|
||||||
- **MCP Resources** - Structured data URIs for browsing Nextcloud data
|
- **MCP Resources** - Structured data URIs for browsing Nextcloud data
|
||||||
- **Semantic Search (Experimental)** - Optional vector-powered search for Notes, Files, News items, and Deck cards (requires Qdrant + Ollama)
|
- **Semantic Search (Experimental)** - Optional vector-powered search for Notes, Files, News items, and Deck cards (requires Qdrant + Ollama)
|
||||||
- **Document Processing** - OCR and text extraction from PDFs, DOCX, images with progress notifications
|
- **Document Processing** - OCR and text extraction from PDFs, DOCX, images with progress notifications
|
||||||
- **Flexible Deployment** - Docker, Kubernetes ([Helm chart](https://github.com/cbcoutinho/helm-charts)), VM, or local installation
|
- **Flexible Deployment** - Docker, Kubernetes ([Helm chart](https://github.com/cbcoutinho/helm-charts)), VM, or local installation
|
||||||
- **Production-Ready Auth** - Basic Auth with app passwords (recommended) or OAuth2/OIDC (experimental)
|
- **Production-Ready Auth** - Basic Auth with app passwords (recommended) or OAuth2/OIDC (experimental)
|
||||||
- **Multiple Transports** - stdio (default) and streamable-http
|
- **Multiple Transports** - streamable-http (default) and stdio
|
||||||
|
|
||||||
## Supported Apps
|
## Supported Apps
|
||||||
|
|
||||||
@@ -105,6 +105,8 @@ docker compose --profile login-flow up -d # Port 8004
|
|||||||
| **Cookbook** | 13 | Recipe management, URL import (schema.org) |
|
| **Cookbook** | 13 | Recipe management, URL import (schema.org) |
|
||||||
| **Tables** | 5 | Row operations on Nextcloud Tables |
|
| **Tables** | 5 | Row operations on Nextcloud Tables |
|
||||||
| **Sharing** | 10+ | Create and manage shares |
|
| **Sharing** | 10+ | Create and manage shares |
|
||||||
|
| **News** | 8 | Feeds, folders, items, feed health monitoring |
|
||||||
|
| **Collectives** | 16 | Full CRUD on collectives, pages, and tags |
|
||||||
| **Semantic Search** | 2+ | Vector search for Notes, Files, News items, and Deck cards (experimental, opt-in, requires infrastructure) |
|
| **Semantic Search** | 2+ | Vector search for Notes, Files, News items, and Deck cards (experimental, opt-in, requires infrastructure) |
|
||||||
|
|
||||||
Want to see another Nextcloud app supported? [Open an issue](https://github.com/cbcoutinho/nextcloud-mcp-server/issues) or contribute a pull request!
|
Want to see another Nextcloud app supported? [Open an issue](https://github.com/cbcoutinho/nextcloud-mcp-server/issues) or contribute a pull request!
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
"""Helper functions for accessing context in MCP tools."""
|
"""Helper functions for accessing context in MCP tools."""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
from typing import Protocol, runtime_checkable
|
||||||
|
|
||||||
from httpx import BasicAuth
|
from httpx import BasicAuth
|
||||||
from mcp.server.fastmcp import Context
|
from mcp.server.fastmcp import Context
|
||||||
@@ -14,6 +15,17 @@ from nextcloud_mcp_server.config import get_settings
|
|||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
@runtime_checkable
|
||||||
|
class BasicAuthLifespanContext(Protocol):
|
||||||
|
"""Protocol for lifespan contexts that carry a shared NextcloudClient.
|
||||||
|
|
||||||
|
Implemented by :class:`~nextcloud_mcp_server.stdio.StdioContext` and
|
||||||
|
the single-user lifespan context in ``app.py``.
|
||||||
|
"""
|
||||||
|
|
||||||
|
client: NextcloudClient
|
||||||
|
|
||||||
|
|
||||||
async def get_client(ctx: Context) -> NextcloudClient:
|
async def get_client(ctx: Context) -> NextcloudClient:
|
||||||
"""
|
"""
|
||||||
Get the appropriate Nextcloud client based on authentication mode.
|
Get the appropriate Nextcloud client based on authentication mode.
|
||||||
@@ -59,7 +71,7 @@ async def get_client(ctx: Context) -> NextcloudClient:
|
|||||||
return await _get_client_from_login_flow(ctx, lifespan_ctx.nextcloud_host)
|
return await _get_client_from_login_flow(ctx, lifespan_ctx.nextcloud_host)
|
||||||
|
|
||||||
# BasicAuth mode - use shared client (no token exchange)
|
# BasicAuth mode - use shared client (no token exchange)
|
||||||
if hasattr(lifespan_ctx, "client"):
|
if isinstance(lifespan_ctx, BasicAuthLifespanContext):
|
||||||
return lifespan_ctx.client
|
return lifespan_ctx.client
|
||||||
|
|
||||||
# OAuth multi-audience mode (has 'nextcloud_host' attribute)
|
# OAuth multi-audience mode (has 'nextcloud_host' attribute)
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ from mcp.server.fastmcp import Context, FastMCP
|
|||||||
from nextcloud_mcp_server.client import NextcloudClient
|
from nextcloud_mcp_server.client import NextcloudClient
|
||||||
from nextcloud_mcp_server.config import get_settings
|
from nextcloud_mcp_server.config import get_settings
|
||||||
from nextcloud_mcp_server.config_validators import AuthMode, validate_configuration
|
from nextcloud_mcp_server.config_validators import AuthMode, validate_configuration
|
||||||
|
from nextcloud_mcp_server.context import BasicAuthLifespanContext
|
||||||
from nextcloud_mcp_server.context import get_client as get_nextcloud_client
|
from nextcloud_mcp_server.context import get_client as get_nextcloud_client
|
||||||
from nextcloud_mcp_server.server import AVAILABLE_APPS
|
from nextcloud_mcp_server.server import AVAILABLE_APPS
|
||||||
|
|
||||||
@@ -24,12 +25,12 @@ logger = logging.getLogger(__name__)
|
|||||||
|
|
||||||
|
|
||||||
@dataclass
|
@dataclass
|
||||||
class StdioContext:
|
class StdioContext(BasicAuthLifespanContext):
|
||||||
"""Minimal lifespan context for stdio transport.
|
"""Minimal lifespan context for stdio transport.
|
||||||
|
|
||||||
Carries only the shared :class:`NextcloudClient`. The ``client``
|
Implements :class:`~nextcloud_mcp_server.context.BasicAuthLifespanContext`
|
||||||
attribute satisfies the duck-type check in
|
so that :func:`~nextcloud_mcp_server.context.get_client` recognises it
|
||||||
:func:`nextcloud_mcp_server.context.get_client`.
|
as a single-user BasicAuth context.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
client: NextcloudClient
|
client: NextcloudClient
|
||||||
@@ -79,6 +80,9 @@ def get_stdio_mcp(enabled_apps: list[str] | None = None) -> FastMCP:
|
|||||||
mcp = FastMCP("Nextcloud MCP", lifespan=stdio_lifespan)
|
mcp = FastMCP("Nextcloud MCP", lifespan=stdio_lifespan)
|
||||||
|
|
||||||
# --- capabilities resource (mirrors app.py) ---
|
# --- capabilities resource (mirrors app.py) ---
|
||||||
|
# NOTE: mcp.get_context() is required here because FastMCP's
|
||||||
|
# FunctionResource (non-template resources) does not support
|
||||||
|
# context parameter injection — only template resources do.
|
||||||
@mcp.resource("nc://capabilities")
|
@mcp.resource("nc://capabilities")
|
||||||
async def nc_get_capabilities():
|
async def nc_get_capabilities():
|
||||||
"""Get the Nextcloud Host capabilities"""
|
"""Get the Nextcloud Host capabilities"""
|
||||||
|
|||||||
Reference in New Issue
Block a user