Chris CoutinhoandClaude Opus 4.7
7d633a945d
- Validate description_max_length is positive (raises ValueError on 0 or negative); the prior code would have wiped descriptions to a single ellipsis character on description_max_length=0. - Extract filter logic into testable module-level helpers (_apply_board_filters, _apply_stack_filters, _apply_card_filters) and replace the dense `continue`-based loop in deck_get_stacks with the reviewer's elif form. - Document the truncation length quirk in the helper docstring (result is description_max_length + 1 chars when truncation fires). - Add 13 new unit tests covering the include/exclude flags on board, stacks, and flat card lists, plus the new validation paths and an explicit "description fits within limit, no ellipsis" case. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1034 lines
35 KiB
Python
1034 lines
35 KiB
Python
import logging
|
|
from typing import Optional
|
|
|
|
from mcp.server.fastmcp import Context, FastMCP
|
|
from mcp.types import ToolAnnotations
|
|
|
|
from nextcloud_mcp_server.auth import require_scopes
|
|
from nextcloud_mcp_server.context import get_client
|
|
from nextcloud_mcp_server.models.deck import (
|
|
CardCommentOperationResponse,
|
|
CardCommentResponse,
|
|
CardOperationResponse,
|
|
CreateBoardResponse,
|
|
CreateCardResponse,
|
|
CreateLabelResponse,
|
|
CreateStackResponse,
|
|
DeckBoard,
|
|
DeckCard,
|
|
DeckLabel,
|
|
DeckStack,
|
|
LabelOperationResponse,
|
|
ListBoardsResponse,
|
|
ListCardCommentsResponse,
|
|
ListCardsResponse,
|
|
ListLabelsResponse,
|
|
ListStacksResponse,
|
|
StackOperationResponse,
|
|
)
|
|
from nextcloud_mcp_server.observability.metrics import instrument_tool
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
def _truncate_card_descriptions(
|
|
cards: list[DeckCard], description_max_length: int | None
|
|
) -> None:
|
|
"""Truncate each card's description in-place when it strictly exceeds the
|
|
limit.
|
|
|
|
Descriptions whose length is less than or equal to ``description_max_length``
|
|
are left untouched (no ellipsis is appended). Descriptions longer than the
|
|
limit are truncated to ``description_max_length`` characters and an
|
|
ellipsis ("…") is appended, so the resulting string is
|
|
``description_max_length + 1`` characters total.
|
|
|
|
Args:
|
|
cards: Cards to mutate in place.
|
|
description_max_length: Positive truncation threshold, or ``None`` to
|
|
skip truncation entirely.
|
|
|
|
Raises:
|
|
ValueError: If ``description_max_length`` is not positive.
|
|
"""
|
|
if description_max_length is None:
|
|
return
|
|
if description_max_length <= 0:
|
|
raise ValueError(
|
|
f"description_max_length must be positive, got {description_max_length}"
|
|
)
|
|
for card in cards:
|
|
if card.description and len(card.description) > description_max_length:
|
|
card.description = card.description[:description_max_length] + "…"
|
|
|
|
|
|
def _apply_board_filters(
|
|
board: DeckBoard,
|
|
*,
|
|
include_acl: bool,
|
|
include_users: bool,
|
|
include_labels: bool,
|
|
) -> DeckBoard:
|
|
"""Drop board sub-fields the caller didn't request (in-place)."""
|
|
if not include_acl:
|
|
board.acl = []
|
|
if not include_users:
|
|
board.users = []
|
|
if not include_labels:
|
|
board.labels = []
|
|
return board
|
|
|
|
|
|
def _apply_stack_filters(
|
|
stack: DeckStack,
|
|
*,
|
|
include_cards: bool,
|
|
include_archived_cards: bool,
|
|
description_max_length: int | None,
|
|
) -> DeckStack:
|
|
"""Apply card-shaping filters to a single stack (in-place)."""
|
|
if not include_cards:
|
|
stack.cards = None
|
|
elif stack.cards:
|
|
if not include_archived_cards:
|
|
stack.cards = [c for c in stack.cards if not c.archived]
|
|
_truncate_card_descriptions(stack.cards, description_max_length)
|
|
return stack
|
|
|
|
|
|
def _apply_card_filters(
|
|
cards: list[DeckCard],
|
|
*,
|
|
include_archived: bool,
|
|
description_max_length: int | None,
|
|
) -> list[DeckCard]:
|
|
"""Apply filters to a flat list of cards. Returns a (possibly new) list."""
|
|
if not include_archived:
|
|
cards = [c for c in cards if not c.archived]
|
|
_truncate_card_descriptions(cards, description_max_length)
|
|
return cards
|
|
|
|
|
|
def configure_deck_tools(mcp: FastMCP):
|
|
"""Configure Nextcloud Deck tools and resources for the MCP server."""
|
|
|
|
# Resources
|
|
@mcp.resource("nc://Deck/boards")
|
|
async def deck_boards_resource():
|
|
"""List all Nextcloud Deck boards"""
|
|
ctx: Context = mcp.get_context()
|
|
await ctx.warning("This message is deprecated, use the deck_get_board instead")
|
|
client = await get_client(ctx)
|
|
boards = await client.deck.get_boards()
|
|
return [board.model_dump() for board in boards]
|
|
|
|
@mcp.resource("nc://Deck/boards/{board_id}")
|
|
async def deck_board_resource(board_id: int):
|
|
"""Get details of a specific Nextcloud Deck board"""
|
|
ctx: Context = mcp.get_context()
|
|
await ctx.warning(
|
|
"This resource is deprecated, use the deck_get_board tool instead"
|
|
)
|
|
client = await get_client(ctx)
|
|
board = await client.deck.get_board(board_id)
|
|
return board.model_dump()
|
|
|
|
@mcp.resource("nc://Deck/boards/{board_id}/stacks")
|
|
async def deck_stacks_resource(board_id: int):
|
|
"""List all stacks in a Nextcloud Deck board"""
|
|
ctx: Context = mcp.get_context()
|
|
await ctx.warning(
|
|
"This resource is deprecated, use the deck_get_stacks tool instead"
|
|
)
|
|
client = await get_client(ctx)
|
|
stacks = await client.deck.get_stacks(board_id)
|
|
return [stack.model_dump() for stack in stacks]
|
|
|
|
@mcp.resource("nc://Deck/boards/{board_id}/stacks/{stack_id}")
|
|
async def deck_stack_resource(board_id: int, stack_id: int):
|
|
"""Get details of a specific Nextcloud Deck stack"""
|
|
ctx: Context = mcp.get_context()
|
|
await ctx.warning(
|
|
"This resource is deprecated, use the deck_get_stack tool instead"
|
|
)
|
|
client = await get_client(ctx)
|
|
stack = await client.deck.get_stack(board_id, stack_id)
|
|
return stack.model_dump()
|
|
|
|
@mcp.resource("nc://Deck/boards/{board_id}/stacks/{stack_id}/cards")
|
|
async def deck_cards_resource(board_id: int, stack_id: int):
|
|
"""List all cards in a Nextcloud Deck stack"""
|
|
ctx: Context = mcp.get_context()
|
|
await ctx.warning(
|
|
"This resource is deprecated, use the deck_get_cards tool instead"
|
|
)
|
|
client = await get_client(ctx)
|
|
stack = await client.deck.get_stack(board_id, stack_id)
|
|
if stack.cards:
|
|
return [card.model_dump() for card in stack.cards]
|
|
return []
|
|
|
|
@mcp.resource("nc://Deck/boards/{board_id}/stacks/{stack_id}/cards/{card_id}")
|
|
async def deck_card_resource(board_id: int, stack_id: int, card_id: int):
|
|
"""Get details of a specific Nextcloud Deck card"""
|
|
ctx: Context = mcp.get_context()
|
|
await ctx.warning(
|
|
"This resource is deprecated, use the deck_get_card tool instead"
|
|
)
|
|
client = await get_client(ctx)
|
|
card = await client.deck.get_card(board_id, stack_id, card_id)
|
|
return card.model_dump()
|
|
|
|
@mcp.resource("nc://Deck/boards/{board_id}/labels")
|
|
async def deck_labels_resource(board_id: int):
|
|
"""List all labels in a Nextcloud Deck board"""
|
|
ctx: Context = mcp.get_context()
|
|
await ctx.warning(
|
|
"This resource is deprecated, use the deck_get_labels tool instead"
|
|
)
|
|
client = await get_client(ctx)
|
|
board = await client.deck.get_board(board_id)
|
|
return [label.model_dump() for label in (board.labels or [])]
|
|
|
|
@mcp.resource("nc://Deck/boards/{board_id}/labels/{label_id}")
|
|
async def deck_label_resource(board_id: int, label_id: int):
|
|
"""Get details of a specific Nextcloud Deck label"""
|
|
ctx: Context = mcp.get_context()
|
|
await ctx.warning(
|
|
"This resource is deprecated, use the deck_get_label tool instead"
|
|
)
|
|
client = await get_client(ctx)
|
|
label = await client.deck.get_label(board_id, label_id)
|
|
return label.model_dump()
|
|
|
|
# Read Tools (converted from resources)
|
|
|
|
@mcp.tool(
|
|
title="List Deck Boards",
|
|
annotations=ToolAnnotations(readOnlyHint=True, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.read")
|
|
@instrument_tool
|
|
async def deck_get_boards(ctx: Context) -> ListBoardsResponse:
|
|
"""Get all Nextcloud Deck boards"""
|
|
client = await get_client(ctx)
|
|
boards = await client.deck.get_boards()
|
|
return ListBoardsResponse(boards=boards, total=len(boards))
|
|
|
|
@mcp.tool(
|
|
title="Get Deck Board",
|
|
annotations=ToolAnnotations(readOnlyHint=True, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.read")
|
|
@instrument_tool
|
|
async def deck_get_board(
|
|
ctx: Context,
|
|
board_id: int,
|
|
include_acl: bool = True,
|
|
include_users: bool = True,
|
|
include_labels: bool = True,
|
|
) -> DeckBoard:
|
|
"""Get details of a specific Nextcloud Deck board.
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
include_acl: Include the board's ACL entries (default True). Set
|
|
False to reduce response size when ACLs are not needed.
|
|
include_users: Include the board's user list (default True). Set
|
|
False to reduce response size when users are not needed.
|
|
include_labels: Include the board's label definitions (default
|
|
True). Set False to reduce response size; labels can still be
|
|
retrieved via deck_get_labels.
|
|
"""
|
|
client = await get_client(ctx)
|
|
board = await client.deck.get_board(board_id)
|
|
return _apply_board_filters(
|
|
board,
|
|
include_acl=include_acl,
|
|
include_users=include_users,
|
|
include_labels=include_labels,
|
|
)
|
|
|
|
@mcp.tool(
|
|
title="List Deck Stacks",
|
|
annotations=ToolAnnotations(readOnlyHint=True, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.read")
|
|
@instrument_tool
|
|
async def deck_get_stacks(
|
|
ctx: Context,
|
|
board_id: int,
|
|
include_cards: bool = True,
|
|
include_archived_cards: bool = False,
|
|
description_max_length: int | None = None,
|
|
) -> ListStacksResponse:
|
|
"""Get all stacks in a Nextcloud Deck board.
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
include_cards: Include cards inside each stack (default True). Set
|
|
False for a lightweight stack listing; fetch cards separately
|
|
via deck_get_cards.
|
|
include_archived_cards: Include archived cards (default False).
|
|
Only relevant when include_cards is True.
|
|
description_max_length: If set, truncate each card's description
|
|
to this many characters. Useful for keeping responses compact
|
|
on boards with long card specs.
|
|
"""
|
|
client = await get_client(ctx)
|
|
stacks = await client.deck.get_stacks(board_id)
|
|
for stack in stacks:
|
|
_apply_stack_filters(
|
|
stack,
|
|
include_cards=include_cards,
|
|
include_archived_cards=include_archived_cards,
|
|
description_max_length=description_max_length,
|
|
)
|
|
return ListStacksResponse(stacks=stacks, total=len(stacks))
|
|
|
|
@mcp.tool(
|
|
title="Get Deck Stack",
|
|
annotations=ToolAnnotations(readOnlyHint=True, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.read")
|
|
@instrument_tool
|
|
async def deck_get_stack(
|
|
ctx: Context,
|
|
board_id: int,
|
|
stack_id: int,
|
|
include_cards: bool = True,
|
|
include_archived_cards: bool = False,
|
|
description_max_length: int | None = None,
|
|
) -> DeckStack:
|
|
"""Get details of a specific Nextcloud Deck stack.
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
stack_id: The ID of the stack
|
|
include_cards: Include cards in the stack (default True).
|
|
include_archived_cards: Include archived cards (default False).
|
|
Only relevant when include_cards is True.
|
|
description_max_length: If set, truncate each card's description
|
|
to this many characters.
|
|
"""
|
|
client = await get_client(ctx)
|
|
stack = await client.deck.get_stack(board_id, stack_id)
|
|
return _apply_stack_filters(
|
|
stack,
|
|
include_cards=include_cards,
|
|
include_archived_cards=include_archived_cards,
|
|
description_max_length=description_max_length,
|
|
)
|
|
|
|
@mcp.tool(
|
|
title="List Archived Deck Stacks",
|
|
annotations=ToolAnnotations(readOnlyHint=True, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.read")
|
|
@instrument_tool
|
|
async def deck_get_archived_stacks(
|
|
ctx: Context,
|
|
board_id: int,
|
|
description_max_length: int | None = None,
|
|
) -> ListStacksResponse:
|
|
"""List archived stacks (with their archived cards) for a Nextcloud
|
|
Deck board.
|
|
|
|
Use this to audit completed work that has been archived off the
|
|
active board (e.g. cards moved through a "Done" stack and then
|
|
archived via deck_archive_card). The shape mirrors deck_get_stacks.
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
description_max_length: If set, truncate each card's description
|
|
to this many characters.
|
|
"""
|
|
client = await get_client(ctx)
|
|
stacks = await client.deck.get_archived_stacks(board_id)
|
|
for stack in stacks:
|
|
if stack.cards:
|
|
_truncate_card_descriptions(stack.cards, description_max_length)
|
|
return ListStacksResponse(stacks=stacks, total=len(stacks))
|
|
|
|
@mcp.tool(
|
|
title="List Deck Cards",
|
|
annotations=ToolAnnotations(readOnlyHint=True, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.read")
|
|
@instrument_tool
|
|
async def deck_get_cards(
|
|
ctx: Context,
|
|
board_id: int,
|
|
stack_id: int,
|
|
include_archived: bool = False,
|
|
description_max_length: int | None = None,
|
|
) -> ListCardsResponse:
|
|
"""Get all cards in a Nextcloud Deck stack.
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
stack_id: The ID of the stack
|
|
include_archived: Include archived cards (default False). Archived
|
|
cards can also be retrieved per-board via
|
|
deck_get_archived_stacks.
|
|
description_max_length: If set, truncate each card's description
|
|
to this many characters.
|
|
"""
|
|
client = await get_client(ctx)
|
|
stack = await client.deck.get_stack(board_id, stack_id)
|
|
cards = _apply_card_filters(
|
|
stack.cards or [],
|
|
include_archived=include_archived,
|
|
description_max_length=description_max_length,
|
|
)
|
|
return ListCardsResponse(cards=cards, total=len(cards))
|
|
|
|
@mcp.tool(
|
|
title="Get Deck Card",
|
|
annotations=ToolAnnotations(readOnlyHint=True, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.read")
|
|
@instrument_tool
|
|
async def deck_get_card(
|
|
ctx: Context, board_id: int, stack_id: int, card_id: int
|
|
) -> DeckCard:
|
|
"""Get details of a specific Nextcloud Deck card"""
|
|
client = await get_client(ctx)
|
|
card = await client.deck.get_card(board_id, stack_id, card_id)
|
|
return card
|
|
|
|
@mcp.tool(
|
|
title="List Deck Labels",
|
|
annotations=ToolAnnotations(readOnlyHint=True, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.read")
|
|
@instrument_tool
|
|
async def deck_get_labels(ctx: Context, board_id: int) -> ListLabelsResponse:
|
|
"""Get all labels in a Nextcloud Deck board"""
|
|
client = await get_client(ctx)
|
|
board = await client.deck.get_board(board_id)
|
|
labels = board.labels or []
|
|
return ListLabelsResponse(labels=labels, total=len(labels))
|
|
|
|
@mcp.tool(
|
|
title="Get Deck Label",
|
|
annotations=ToolAnnotations(readOnlyHint=True, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.read")
|
|
@instrument_tool
|
|
async def deck_get_label(ctx: Context, board_id: int, label_id: int) -> DeckLabel:
|
|
"""Get details of a specific Nextcloud Deck label"""
|
|
client = await get_client(ctx)
|
|
label = await client.deck.get_label(board_id, label_id)
|
|
return label
|
|
|
|
# Create/Update/Delete Tools
|
|
|
|
@mcp.tool(
|
|
title="Create Deck Board",
|
|
annotations=ToolAnnotations(idempotentHint=False, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_create_board(
|
|
ctx: Context, title: str, color: str
|
|
) -> CreateBoardResponse:
|
|
"""Create a new Nextcloud Deck board
|
|
|
|
Args:
|
|
title: The title of the new board
|
|
color: The hexadecimal color of the new board (e.g. FF0000)
|
|
"""
|
|
client = await get_client(ctx)
|
|
board = await client.deck.create_board(title, color)
|
|
return CreateBoardResponse(id=board.id, title=board.title, color=board.color)
|
|
|
|
# Stack Tools
|
|
|
|
@mcp.tool(
|
|
title="Create Deck Stack",
|
|
annotations=ToolAnnotations(idempotentHint=False, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_create_stack(
|
|
ctx: Context, board_id: int, title: str, order: int
|
|
) -> CreateStackResponse:
|
|
"""Create a new stack in a Nextcloud Deck board
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
title: The title of the new stack
|
|
order: Order for sorting the stacks
|
|
"""
|
|
client = await get_client(ctx)
|
|
stack = await client.deck.create_stack(board_id, title, order)
|
|
return CreateStackResponse(id=stack.id, title=stack.title, order=stack.order)
|
|
|
|
@mcp.tool(
|
|
title="Update Deck Stack",
|
|
annotations=ToolAnnotations(idempotentHint=False, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_update_stack(
|
|
ctx: Context,
|
|
board_id: int,
|
|
stack_id: int,
|
|
title: Optional[str] = None,
|
|
order: Optional[int] = None,
|
|
) -> StackOperationResponse:
|
|
"""Update a Nextcloud Deck stack
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
stack_id: The ID of the stack
|
|
title: New title for the stack
|
|
order: New order for the stack
|
|
"""
|
|
client = await get_client(ctx)
|
|
await client.deck.update_stack(board_id, stack_id, title, order)
|
|
return StackOperationResponse(
|
|
success=True,
|
|
message="Stack updated successfully",
|
|
stack_id=stack_id,
|
|
board_id=board_id,
|
|
)
|
|
|
|
@mcp.tool(
|
|
title="Delete Deck Stack",
|
|
annotations=ToolAnnotations(
|
|
destructiveHint=True, idempotentHint=True, openWorldHint=True
|
|
),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_delete_stack(
|
|
ctx: Context, board_id: int, stack_id: int
|
|
) -> StackOperationResponse:
|
|
"""Delete a Nextcloud Deck stack
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
stack_id: The ID of the stack
|
|
"""
|
|
client = await get_client(ctx)
|
|
await client.deck.delete_stack(board_id, stack_id)
|
|
return StackOperationResponse(
|
|
success=True,
|
|
message="Stack deleted successfully",
|
|
stack_id=stack_id,
|
|
board_id=board_id,
|
|
)
|
|
|
|
# Card Tools
|
|
@mcp.tool(
|
|
title="Create Deck Card",
|
|
annotations=ToolAnnotations(idempotentHint=False, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_create_card(
|
|
ctx: Context,
|
|
board_id: int,
|
|
stack_id: int,
|
|
title: str,
|
|
type: str = "plain",
|
|
order: int = 999,
|
|
description: Optional[str] = None,
|
|
duedate: Optional[str] = None,
|
|
) -> CreateCardResponse:
|
|
"""Create a new card in a Nextcloud Deck stack
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
stack_id: The ID of the stack
|
|
title: The title of the new card
|
|
type: Type of the card (default: plain)
|
|
order: Order for sorting the cards
|
|
description: Description of the card
|
|
duedate: Due date of the card (ISO-8601 format)
|
|
"""
|
|
client = await get_client(ctx)
|
|
card = await client.deck.create_card(
|
|
board_id, stack_id, title, type, order, description, duedate
|
|
)
|
|
return CreateCardResponse(
|
|
id=card.id,
|
|
title=card.title,
|
|
description=card.description,
|
|
stackId=card.stackId,
|
|
)
|
|
|
|
@mcp.tool(
|
|
title="Update Deck Card",
|
|
annotations=ToolAnnotations(idempotentHint=False, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_update_card(
|
|
ctx: Context,
|
|
board_id: int,
|
|
stack_id: int,
|
|
card_id: int,
|
|
title: Optional[str] = None,
|
|
description: Optional[str] = None,
|
|
type: Optional[str] = None,
|
|
owner: Optional[str] = None,
|
|
order: Optional[int] = None,
|
|
duedate: Optional[str] = None,
|
|
archived: Optional[bool] = None,
|
|
done: Optional[str] = None,
|
|
) -> CardOperationResponse:
|
|
"""Update a Nextcloud Deck card
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
stack_id: The ID of the stack
|
|
card_id: The ID of the card
|
|
title: New title for the card
|
|
description: New description for the card
|
|
type: New type for the card
|
|
owner: New owner for the card
|
|
order: New order for the card
|
|
duedate: New due date for the card (ISO-8601 format)
|
|
archived: Whether the card should be archived
|
|
done: Completion date for the card (ISO-8601 format)
|
|
"""
|
|
client = await get_client(ctx)
|
|
await client.deck.update_card(
|
|
board_id,
|
|
stack_id,
|
|
card_id,
|
|
title,
|
|
description,
|
|
type,
|
|
owner,
|
|
order,
|
|
duedate,
|
|
archived,
|
|
done,
|
|
)
|
|
return CardOperationResponse(
|
|
success=True,
|
|
message="Card updated successfully",
|
|
card_id=card_id,
|
|
stack_id=stack_id,
|
|
board_id=board_id,
|
|
)
|
|
|
|
@mcp.tool(
|
|
title="Delete Deck Card",
|
|
annotations=ToolAnnotations(
|
|
destructiveHint=True, idempotentHint=True, openWorldHint=True
|
|
),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_delete_card(
|
|
ctx: Context, board_id: int, stack_id: int, card_id: int
|
|
) -> CardOperationResponse:
|
|
"""Delete a Nextcloud Deck card
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
stack_id: The ID of the stack
|
|
card_id: The ID of the card
|
|
"""
|
|
client = await get_client(ctx)
|
|
await client.deck.delete_card(board_id, stack_id, card_id)
|
|
return CardOperationResponse(
|
|
success=True,
|
|
message="Card deleted successfully",
|
|
card_id=card_id,
|
|
stack_id=stack_id,
|
|
board_id=board_id,
|
|
)
|
|
|
|
@mcp.tool(
|
|
title="Archive Deck Card",
|
|
annotations=ToolAnnotations(idempotentHint=False, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_archive_card(
|
|
ctx: Context, board_id: int, stack_id: int, card_id: int
|
|
) -> CardOperationResponse:
|
|
"""Archive a Nextcloud Deck card
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
stack_id: The ID of the stack
|
|
card_id: The ID of the card
|
|
"""
|
|
client = await get_client(ctx)
|
|
await client.deck.archive_card(board_id, stack_id, card_id)
|
|
return CardOperationResponse(
|
|
success=True,
|
|
message="Card archived successfully",
|
|
card_id=card_id,
|
|
stack_id=stack_id,
|
|
board_id=board_id,
|
|
)
|
|
|
|
@mcp.tool(
|
|
title="Unarchive Deck Card",
|
|
annotations=ToolAnnotations(idempotentHint=False, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_unarchive_card(
|
|
ctx: Context, board_id: int, stack_id: int, card_id: int
|
|
) -> CardOperationResponse:
|
|
"""Unarchive a Nextcloud Deck card
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
stack_id: The ID of the stack
|
|
card_id: The ID of the card
|
|
"""
|
|
client = await get_client(ctx)
|
|
await client.deck.unarchive_card(board_id, stack_id, card_id)
|
|
return CardOperationResponse(
|
|
success=True,
|
|
message="Card unarchived successfully",
|
|
card_id=card_id,
|
|
stack_id=stack_id,
|
|
board_id=board_id,
|
|
)
|
|
|
|
@mcp.tool(
|
|
title="Reorder/Move Deck Card",
|
|
annotations=ToolAnnotations(idempotentHint=False, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_reorder_card(
|
|
ctx: Context,
|
|
board_id: int,
|
|
stack_id: int,
|
|
card_id: int,
|
|
order: int,
|
|
target_stack_id: int,
|
|
) -> CardOperationResponse:
|
|
"""Reorder/move a Nextcloud Deck card
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
stack_id: The ID of the current stack
|
|
card_id: The ID of the card
|
|
order: New position in the target stack
|
|
target_stack_id: The ID of the target stack
|
|
"""
|
|
client = await get_client(ctx)
|
|
await client.deck.reorder_card(
|
|
board_id, stack_id, card_id, order, target_stack_id
|
|
)
|
|
return CardOperationResponse(
|
|
success=True,
|
|
message="Card reordered successfully",
|
|
card_id=card_id,
|
|
stack_id=target_stack_id,
|
|
board_id=board_id,
|
|
)
|
|
|
|
# Label Tools
|
|
@mcp.tool(
|
|
title="Create Deck Label",
|
|
annotations=ToolAnnotations(idempotentHint=False, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_create_label(
|
|
ctx: Context, board_id: int, title: str, color: str
|
|
) -> CreateLabelResponse:
|
|
"""Create a new label in a Nextcloud Deck board
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
title: The title of the new label
|
|
color: The color of the new label (hex format without #)
|
|
"""
|
|
client = await get_client(ctx)
|
|
label = await client.deck.create_label(board_id, title, color)
|
|
return CreateLabelResponse(id=label.id, title=label.title, color=label.color)
|
|
|
|
@mcp.tool(
|
|
title="Update Deck Label",
|
|
annotations=ToolAnnotations(idempotentHint=False, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_update_label(
|
|
ctx: Context,
|
|
board_id: int,
|
|
label_id: int,
|
|
title: Optional[str] = None,
|
|
color: Optional[str] = None,
|
|
) -> LabelOperationResponse:
|
|
"""Update a Nextcloud Deck label
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
label_id: The ID of the label
|
|
title: New title for the label
|
|
color: New color for the label (hex format without #)
|
|
"""
|
|
client = await get_client(ctx)
|
|
await client.deck.update_label(board_id, label_id, title, color)
|
|
return LabelOperationResponse(
|
|
success=True,
|
|
message="Label updated successfully",
|
|
label_id=label_id,
|
|
board_id=board_id,
|
|
)
|
|
|
|
@mcp.tool(
|
|
title="Delete Deck Label",
|
|
annotations=ToolAnnotations(
|
|
destructiveHint=True, idempotentHint=True, openWorldHint=True
|
|
),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_delete_label(
|
|
ctx: Context, board_id: int, label_id: int
|
|
) -> LabelOperationResponse:
|
|
"""Delete a Nextcloud Deck label
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
label_id: The ID of the label
|
|
"""
|
|
client = await get_client(ctx)
|
|
await client.deck.delete_label(board_id, label_id)
|
|
return LabelOperationResponse(
|
|
success=True,
|
|
message="Label deleted successfully",
|
|
label_id=label_id,
|
|
board_id=board_id,
|
|
)
|
|
|
|
# Card-Label Assignment Tools
|
|
@mcp.tool(
|
|
title="Assign Label to Deck Card",
|
|
annotations=ToolAnnotations(idempotentHint=False, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_assign_label_to_card(
|
|
ctx: Context, board_id: int, stack_id: int, card_id: int, label_id: int
|
|
) -> CardOperationResponse:
|
|
"""Assign a label to a Nextcloud Deck card
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
stack_id: The ID of the stack
|
|
card_id: The ID of the card
|
|
label_id: The ID of the label to assign
|
|
"""
|
|
client = await get_client(ctx)
|
|
await client.deck.assign_label_to_card(board_id, stack_id, card_id, label_id)
|
|
return CardOperationResponse(
|
|
success=True,
|
|
message="Label assigned to card successfully",
|
|
card_id=card_id,
|
|
stack_id=stack_id,
|
|
board_id=board_id,
|
|
)
|
|
|
|
@mcp.tool(
|
|
title="Remove Label from Deck Card",
|
|
annotations=ToolAnnotations(idempotentHint=True, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_remove_label_from_card(
|
|
ctx: Context, board_id: int, stack_id: int, card_id: int, label_id: int
|
|
) -> CardOperationResponse:
|
|
"""Remove a label from a Nextcloud Deck card
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
stack_id: The ID of the stack
|
|
card_id: The ID of the card
|
|
label_id: The ID of the label to remove
|
|
"""
|
|
client = await get_client(ctx)
|
|
await client.deck.remove_label_from_card(board_id, stack_id, card_id, label_id)
|
|
return CardOperationResponse(
|
|
success=True,
|
|
message="Label removed from card successfully",
|
|
card_id=card_id,
|
|
stack_id=stack_id,
|
|
board_id=board_id,
|
|
)
|
|
|
|
# Card-User Assignment Tools
|
|
@mcp.tool(
|
|
title="Assign User to Deck Card",
|
|
annotations=ToolAnnotations(idempotentHint=False, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_assign_user_to_card(
|
|
ctx: Context, board_id: int, stack_id: int, card_id: int, user_id: str
|
|
) -> CardOperationResponse:
|
|
"""Assign a user to a Nextcloud Deck card
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
stack_id: The ID of the stack
|
|
card_id: The ID of the card
|
|
user_id: The user ID to assign
|
|
"""
|
|
client = await get_client(ctx)
|
|
await client.deck.assign_user_to_card(board_id, stack_id, card_id, user_id)
|
|
return CardOperationResponse(
|
|
success=True,
|
|
message="User assigned to card successfully",
|
|
card_id=card_id,
|
|
stack_id=stack_id,
|
|
board_id=board_id,
|
|
)
|
|
|
|
@mcp.tool(
|
|
title="Unassign User from Deck Card",
|
|
annotations=ToolAnnotations(
|
|
destructiveHint=True, idempotentHint=True, openWorldHint=True
|
|
),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_unassign_user_from_card(
|
|
ctx: Context, board_id: int, stack_id: int, card_id: int, user_id: str
|
|
) -> CardOperationResponse:
|
|
"""Unassign a user from a Nextcloud Deck card
|
|
|
|
Args:
|
|
board_id: The ID of the board
|
|
stack_id: The ID of the stack
|
|
card_id: The ID of the card
|
|
user_id: The user ID to unassign
|
|
"""
|
|
client = await get_client(ctx)
|
|
await client.deck.unassign_user_from_card(board_id, stack_id, card_id, user_id)
|
|
return CardOperationResponse(
|
|
success=True,
|
|
message="User unassigned from card successfully",
|
|
card_id=card_id,
|
|
stack_id=stack_id,
|
|
board_id=board_id,
|
|
)
|
|
|
|
# Card Comment Tools
|
|
|
|
_COMMENT_MAX_LENGTH = 1000
|
|
|
|
def _validate_comment_message(message: str) -> None:
|
|
if len(message) > _COMMENT_MAX_LENGTH:
|
|
raise ValueError(
|
|
f"Comment message too long: {len(message)} characters "
|
|
f"(max {_COMMENT_MAX_LENGTH})"
|
|
)
|
|
|
|
@mcp.tool(
|
|
title="List Deck Card Comments",
|
|
annotations=ToolAnnotations(readOnlyHint=True, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.read")
|
|
@instrument_tool
|
|
async def deck_get_card_comments(
|
|
ctx: Context, card_id: int, limit: int = 20, offset: int = 0
|
|
) -> ListCardCommentsResponse:
|
|
"""List comments on a Nextcloud Deck card
|
|
|
|
Args:
|
|
card_id: The ID of the card
|
|
limit: Maximum number of comments to return (default 20, max 200)
|
|
offset: Pagination offset (default 0)
|
|
"""
|
|
client = await get_client(ctx)
|
|
comments = await client.deck.get_comments(card_id, limit=limit, offset=offset)
|
|
return ListCardCommentsResponse(results=comments, count=len(comments))
|
|
|
|
@mcp.tool(
|
|
title="Create Deck Card Comment",
|
|
annotations=ToolAnnotations(idempotentHint=False, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_create_card_comment(
|
|
ctx: Context,
|
|
card_id: int,
|
|
message: str,
|
|
parent_id: int | None = None,
|
|
) -> CardCommentResponse:
|
|
"""Create a comment on a Nextcloud Deck card
|
|
|
|
Supports @-mentions (e.g. "@alice"). Pass parent_id to reply to an
|
|
existing comment on the same card. Message is limited to 1000 characters.
|
|
|
|
Args:
|
|
card_id: The ID of the card to comment on
|
|
message: The comment text (max 1000 characters)
|
|
parent_id: Optional ID of a parent comment to reply to
|
|
"""
|
|
_validate_comment_message(message)
|
|
client = await get_client(ctx)
|
|
comment = await client.deck.create_comment(
|
|
card_id, message, parent_id=parent_id
|
|
)
|
|
return CardCommentResponse(comment=comment)
|
|
|
|
@mcp.tool(
|
|
title="Update Deck Card Comment",
|
|
annotations=ToolAnnotations(idempotentHint=False, openWorldHint=True),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_update_card_comment(
|
|
ctx: Context, card_id: int, comment_id: int, message: str
|
|
) -> CardCommentResponse:
|
|
"""Update a Nextcloud Deck card comment
|
|
|
|
Only the comment's author can update it; the server returns 403 otherwise.
|
|
|
|
Args:
|
|
card_id: The ID of the card the comment belongs to
|
|
comment_id: The ID of the comment to update
|
|
message: The new comment text (max 1000 characters)
|
|
"""
|
|
_validate_comment_message(message)
|
|
client = await get_client(ctx)
|
|
comment = await client.deck.update_comment(card_id, comment_id, message)
|
|
return CardCommentResponse(comment=comment)
|
|
|
|
@mcp.tool(
|
|
title="Delete Deck Card Comment",
|
|
annotations=ToolAnnotations(
|
|
destructiveHint=True, idempotentHint=True, openWorldHint=True
|
|
),
|
|
)
|
|
@require_scopes("deck.write")
|
|
@instrument_tool
|
|
async def deck_delete_card_comment(
|
|
ctx: Context, card_id: int, comment_id: int
|
|
) -> CardCommentOperationResponse:
|
|
"""Delete a Nextcloud Deck card comment
|
|
|
|
Only the comment's author can delete it; the server returns 403 otherwise.
|
|
|
|
Args:
|
|
card_id: The ID of the card the comment belongs to
|
|
comment_id: The ID of the comment to delete
|
|
"""
|
|
client = await get_client(ctx)
|
|
await client.deck.delete_comment(card_id, comment_id)
|
|
return CardCommentOperationResponse(
|
|
success=True,
|
|
message="Comment deleted successfully",
|
|
card_id=card_id,
|
|
comment_id=comment_id,
|
|
)
|