feat(deck): Initialize Deck app client/server
This commit is contained in:
Chris Coutinho
@@ -18,6 +18,7 @@ from nextcloud_mcp_server.server import (
|
||||
configure_notes_tools,
|
||||
configure_tables_tools,
|
||||
configure_webdav_tools,
|
||||
configure_deck_tools,
|
||||
)
|
||||
|
||||
|
||||
@@ -65,6 +66,7 @@ def get_app(transport: str = "sse", enabled_apps: list[str] | None = None):
|
||||
"webdav": configure_webdav_tools,
|
||||
"calendar": configure_calendar_tools,
|
||||
"contacts": configure_contacts_tools,
|
||||
"deck": configure_deck_tools,
|
||||
}
|
||||
|
||||
# If no specific apps are specified, enable all
|
||||
@@ -104,7 +106,7 @@ def get_app(transport: str = "sse", enabled_apps: list[str] | None = None):
|
||||
"--enable-app",
|
||||
"-e",
|
||||
multiple=True,
|
||||
type=click.Choice(["notes", "tables", "webdav", "calendar", "contacts"]),
|
||||
type=click.Choice(["notes", "tables", "webdav", "calendar", "contacts", "deck"]),
|
||||
help="Enable specific Nextcloud app APIs. Can be specified multiple times. If not specified, all apps are enabled.",
|
||||
)
|
||||
def run(
|
||||
|
||||
@@ -14,6 +14,7 @@ from httpx import (
|
||||
from ..controllers.notes_search import NotesSearchController
|
||||
from .calendar import CalendarClient
|
||||
from .contacts import ContactsClient
|
||||
from .deck import DeckClient
|
||||
from .notes import NotesClient
|
||||
from .tables import TablesClient
|
||||
from .webdav import WebDAVClient
|
||||
@@ -69,6 +70,7 @@ class NextcloudClient:
|
||||
self.tables = TablesClient(self._client, username)
|
||||
self.calendar = CalendarClient(self._client, username)
|
||||
self.contacts = ContactsClient(self._client, username)
|
||||
self.deck = DeckClient(self._client, username)
|
||||
|
||||
# Initialize controllers
|
||||
self._notes_search = NotesSearchController()
|
||||
|
||||
@@ -0,0 +1,602 @@
|
||||
from typing import List, Optional, Dict, Any
|
||||
|
||||
from nextcloud_mcp_server.client.base import BaseNextcloudClient
|
||||
from nextcloud_mcp_server.models.deck import (
|
||||
DeckBoard,
|
||||
DeckStack,
|
||||
DeckCard,
|
||||
DeckLabel,
|
||||
DeckACL,
|
||||
DeckAttachment,
|
||||
DeckComment,
|
||||
DeckSession,
|
||||
DeckConfig,
|
||||
)
|
||||
|
||||
|
||||
class DeckClient(BaseNextcloudClient):
|
||||
"""Client for Nextcloud Deck app operations."""
|
||||
|
||||
def _get_deck_headers(
|
||||
self, additional_headers: Optional[Dict[str, str]] = None
|
||||
) -> Dict[str, str]:
|
||||
"""Get standard headers required for Deck API calls."""
|
||||
headers = {"OCS-APIRequest": "true", "Content-Type": "application/json"}
|
||||
if additional_headers:
|
||||
headers.update(additional_headers)
|
||||
return headers
|
||||
|
||||
# Boards
|
||||
async def get_boards(
|
||||
self, details: bool = False, if_modified_since: Optional[str] = None
|
||||
) -> List[DeckBoard]:
|
||||
additional_headers = {}
|
||||
if if_modified_since:
|
||||
additional_headers["If-Modified-Since"] = if_modified_since
|
||||
headers = self._get_deck_headers(additional_headers)
|
||||
params = {"details": "true"} if details else {}
|
||||
response = await self._make_request(
|
||||
"GET", "/apps/deck/api/v1.0/boards", headers=headers, params=params
|
||||
)
|
||||
return [DeckBoard(**board) for board in response.json()]
|
||||
|
||||
async def create_board(self, title: str, color: str) -> DeckBoard:
|
||||
json_data = {"title": title, "color": color}
|
||||
headers = self._get_deck_headers()
|
||||
response = await self._make_request(
|
||||
"POST", "/apps/deck/api/v1.0/boards", json=json_data, headers=headers
|
||||
)
|
||||
return DeckBoard(**response.json())
|
||||
|
||||
async def get_board(self, board_id: int) -> DeckBoard:
|
||||
headers = self._get_deck_headers()
|
||||
response = await self._make_request(
|
||||
"GET", f"/apps/deck/api/v1.0/boards/{board_id}", headers=headers
|
||||
)
|
||||
return DeckBoard(**response.json())
|
||||
|
||||
async def update_board(
|
||||
self,
|
||||
board_id: int,
|
||||
title: Optional[str] = None,
|
||||
color: Optional[str] = None,
|
||||
archived: Optional[bool] = None,
|
||||
) -> None:
|
||||
json_data = {}
|
||||
if title is not None:
|
||||
json_data["title"] = title
|
||||
if color is not None:
|
||||
json_data["color"] = color
|
||||
if archived is not None:
|
||||
json_data["archived"] = archived
|
||||
headers = self._get_deck_headers()
|
||||
await self._make_request(
|
||||
"PUT",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}",
|
||||
json=json_data,
|
||||
headers=headers,
|
||||
)
|
||||
|
||||
async def delete_board(self, board_id: int) -> None:
|
||||
headers = self._get_deck_headers()
|
||||
await self._make_request(
|
||||
"DELETE", f"/apps/deck/api/v1.0/boards/{board_id}", headers=headers
|
||||
)
|
||||
|
||||
async def undo_delete_board(self, board_id: int) -> None:
|
||||
headers = self._get_deck_headers()
|
||||
await self._make_request(
|
||||
"POST",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/undo_delete",
|
||||
headers=headers,
|
||||
)
|
||||
|
||||
async def add_acl_rule(
|
||||
self,
|
||||
board_id: int,
|
||||
type: int,
|
||||
participant: str,
|
||||
permission_edit: bool,
|
||||
permission_share: bool,
|
||||
permission_manage: bool,
|
||||
) -> List[DeckACL]:
|
||||
json_data = {
|
||||
"type": type,
|
||||
"participant": participant,
|
||||
"permissionEdit": permission_edit,
|
||||
"permissionShare": permission_share,
|
||||
"permissionManage": permission_manage,
|
||||
}
|
||||
response = await self._make_request(
|
||||
"POST", f"/apps/deck/api/v1.0/boards/{board_id}/acl", json=json_data
|
||||
)
|
||||
return [DeckACL(**acl) for acl in response.json()]
|
||||
|
||||
async def update_acl_rule(
|
||||
self,
|
||||
board_id: int,
|
||||
acl_id: int,
|
||||
permission_edit: Optional[bool] = None,
|
||||
permission_share: Optional[bool] = None,
|
||||
permission_manage: Optional[bool] = None,
|
||||
) -> None:
|
||||
json_data = {}
|
||||
if permission_edit is not None:
|
||||
json_data["permissionEdit"] = permission_edit
|
||||
if permission_share is not None:
|
||||
json_data["permissionShare"] = permission_share
|
||||
if permission_manage is not None:
|
||||
json_data["permissionManage"] = permission_manage
|
||||
await self._make_request(
|
||||
"PUT", f"/apps/deck/api/v1.0/boards/{board_id}/acl/{acl_id}", json=json_data
|
||||
)
|
||||
|
||||
async def delete_acl_rule(self, board_id: int, acl_id: int) -> None:
|
||||
await self._make_request(
|
||||
"DELETE", f"/apps/deck/api/v1.0/boards/{board_id}/acl/{acl_id}"
|
||||
)
|
||||
|
||||
async def clone_board(
|
||||
self,
|
||||
board_id: int,
|
||||
with_cards: bool = False,
|
||||
with_assignments: bool = False,
|
||||
with_labels: bool = False,
|
||||
with_due_date: bool = False,
|
||||
move_cards_to_left_stack: bool = False,
|
||||
restore_archived_cards: bool = False,
|
||||
) -> DeckBoard:
|
||||
json_data = {
|
||||
"withCards": with_cards,
|
||||
"withAssignments": with_assignments,
|
||||
"withLabels": with_labels,
|
||||
"withDueDate": with_due_date,
|
||||
"moveCardsToLeftStack": move_cards_to_left_stack,
|
||||
"restoreArchivedCards": restore_archived_cards,
|
||||
}
|
||||
response = await self._make_request(
|
||||
"POST", f"/apps/deck/api/v1.0/boards/{board_id}/clone", json=json_data
|
||||
)
|
||||
return DeckBoard(**response.json())
|
||||
|
||||
# Stacks
|
||||
async def get_stacks(
|
||||
self, board_id: int, if_modified_since: Optional[str] = None
|
||||
) -> List[DeckStack]:
|
||||
additional_headers = {}
|
||||
if if_modified_since:
|
||||
additional_headers["If-Modified-Since"] = if_modified_since
|
||||
headers = self._get_deck_headers(additional_headers)
|
||||
response = await self._make_request(
|
||||
"GET", f"/apps/deck/api/v1.0/boards/{board_id}/stacks", headers=headers
|
||||
)
|
||||
return [DeckStack(**stack) for stack in response.json()]
|
||||
|
||||
async def get_archived_stacks(self, board_id: int) -> List[DeckStack]:
|
||||
response = await self._make_request(
|
||||
"GET", f"/apps/deck/api/v1.0/boards/{board_id}/stacks/archived"
|
||||
)
|
||||
return [DeckStack(**stack) for stack in response.json()]
|
||||
|
||||
async def get_stack(self, board_id: int, stack_id: int) -> DeckStack:
|
||||
response = await self._make_request(
|
||||
"GET", f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}"
|
||||
)
|
||||
return DeckStack(**response.json())
|
||||
|
||||
async def create_stack(self, board_id: int, title: str, order: int) -> DeckStack:
|
||||
json_data = {"title": title, "order": order}
|
||||
headers = self._get_deck_headers()
|
||||
response = await self._make_request(
|
||||
"POST",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks",
|
||||
json=json_data,
|
||||
headers=headers,
|
||||
)
|
||||
return DeckStack(**response.json())
|
||||
|
||||
async def update_stack(
|
||||
self,
|
||||
board_id: int,
|
||||
stack_id: int,
|
||||
title: Optional[str] = None,
|
||||
order: Optional[int] = None,
|
||||
) -> None:
|
||||
json_data = {}
|
||||
if title is not None:
|
||||
json_data["title"] = title
|
||||
if order is not None:
|
||||
json_data["order"] = order
|
||||
headers = self._get_deck_headers()
|
||||
await self._make_request(
|
||||
"PUT",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}",
|
||||
json=json_data,
|
||||
headers=headers,
|
||||
)
|
||||
|
||||
async def delete_stack(self, board_id: int, stack_id: int) -> None:
|
||||
await self._make_request(
|
||||
"DELETE", f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}"
|
||||
)
|
||||
|
||||
# Cards
|
||||
async def get_card(self, board_id: int, stack_id: int, card_id: int) -> DeckCard:
|
||||
headers = self._get_deck_headers()
|
||||
response = await self._make_request(
|
||||
"GET",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}/cards/{card_id}",
|
||||
headers=headers,
|
||||
)
|
||||
return DeckCard(**response.json())
|
||||
|
||||
async def create_card(
|
||||
self,
|
||||
board_id: int,
|
||||
stack_id: int,
|
||||
title: str,
|
||||
type: str = "plain",
|
||||
order: int = 999,
|
||||
description: Optional[str] = None,
|
||||
duedate: Optional[str] = None,
|
||||
) -> DeckCard:
|
||||
json_data = {
|
||||
"title": title,
|
||||
"type": type,
|
||||
"order": order,
|
||||
}
|
||||
if description is not None:
|
||||
json_data["description"] = description
|
||||
if duedate is not None:
|
||||
json_data["duedate"] = duedate
|
||||
headers = self._get_deck_headers()
|
||||
response = await self._make_request(
|
||||
"POST",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}/cards",
|
||||
json=json_data,
|
||||
headers=headers,
|
||||
)
|
||||
return DeckCard(**response.json())
|
||||
|
||||
async def update_card(
|
||||
self,
|
||||
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,
|
||||
) -> None:
|
||||
# First, get the current card to use existing values for required fields
|
||||
current_card = await self.get_card(board_id, stack_id, card_id)
|
||||
|
||||
json_data = {}
|
||||
if title is not None:
|
||||
json_data["title"] = title
|
||||
if description is not None:
|
||||
json_data["description"] = description
|
||||
# Type is required by the API, use provided or keep current
|
||||
json_data["type"] = type if type is not None else current_card.type
|
||||
# Owner is required by the API, use provided or keep current
|
||||
json_data["owner"] = (
|
||||
owner
|
||||
if owner is not None
|
||||
else (
|
||||
current_card.owner
|
||||
if isinstance(current_card.owner, str)
|
||||
else current_card.owner.uid
|
||||
if hasattr(current_card.owner, "uid")
|
||||
else current_card.owner.primaryKey
|
||||
)
|
||||
)
|
||||
if order is not None:
|
||||
json_data["order"] = order
|
||||
if duedate is not None:
|
||||
json_data["duedate"] = duedate
|
||||
if archived is not None:
|
||||
json_data["archived"] = archived
|
||||
if done is not None:
|
||||
json_data["done"] = done
|
||||
headers = self._get_deck_headers()
|
||||
await self._make_request(
|
||||
"PUT",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}/cards/{card_id}",
|
||||
json=json_data,
|
||||
headers=headers,
|
||||
)
|
||||
|
||||
async def delete_card(self, board_id: int, stack_id: int, card_id: int) -> None:
|
||||
headers = self._get_deck_headers()
|
||||
await self._make_request(
|
||||
"DELETE",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}/cards/{card_id}",
|
||||
headers=headers,
|
||||
)
|
||||
|
||||
async def archive_card(self, board_id: int, stack_id: int, card_id: int) -> None:
|
||||
await self._make_request(
|
||||
"PUT",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}/cards/{card_id}/archive",
|
||||
)
|
||||
|
||||
async def unarchive_card(self, board_id: int, stack_id: int, card_id: int) -> None:
|
||||
await self._make_request(
|
||||
"PUT",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}/cards/{card_id}/unarchive",
|
||||
)
|
||||
|
||||
async def assign_label_to_card(
|
||||
self, board_id: int, stack_id: int, card_id: int, label_id: int
|
||||
) -> None:
|
||||
json_data = {"labelId": label_id}
|
||||
await self._make_request(
|
||||
"PUT",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}/cards/{card_id}/assignLabel",
|
||||
json=json_data,
|
||||
)
|
||||
|
||||
async def remove_label_from_card(
|
||||
self, board_id: int, stack_id: int, card_id: int, label_id: int
|
||||
) -> None:
|
||||
json_data = {"labelId": label_id}
|
||||
await self._make_request(
|
||||
"PUT",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}/cards/{card_id}/removeLabel",
|
||||
json=json_data,
|
||||
)
|
||||
|
||||
async def assign_user_to_card(
|
||||
self, board_id: int, stack_id: int, card_id: int, user_id: str
|
||||
) -> None:
|
||||
json_data = {"userId": user_id}
|
||||
await self._make_request(
|
||||
"PUT",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}/cards/{card_id}/assignUser",
|
||||
json=json_data,
|
||||
)
|
||||
|
||||
async def unassign_user_from_card(
|
||||
self, board_id: int, stack_id: int, card_id: int, user_id: str
|
||||
) -> None:
|
||||
json_data = {"userId": user_id}
|
||||
await self._make_request(
|
||||
"PUT",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}/cards/{card_id}/unassignUser",
|
||||
json=json_data,
|
||||
)
|
||||
|
||||
async def reorder_card(
|
||||
self,
|
||||
board_id: int,
|
||||
stack_id: int,
|
||||
card_id: int,
|
||||
order: int,
|
||||
target_stack_id: int,
|
||||
) -> None:
|
||||
json_data = {"order": order, "stackId": target_stack_id}
|
||||
await self._make_request(
|
||||
"PUT",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}/cards/{card_id}/reorder",
|
||||
json=json_data,
|
||||
)
|
||||
|
||||
# Labels
|
||||
async def get_label(self, board_id: int, label_id: int) -> DeckLabel:
|
||||
headers = self._get_deck_headers()
|
||||
response = await self._make_request(
|
||||
"GET",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/labels/{label_id}",
|
||||
headers=headers,
|
||||
)
|
||||
return DeckLabel(**response.json())
|
||||
|
||||
async def create_label(self, board_id: int, title: str, color: str) -> DeckLabel:
|
||||
json_data = {"title": title, "color": color}
|
||||
headers = self._get_deck_headers()
|
||||
response = await self._make_request(
|
||||
"POST",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/labels",
|
||||
json=json_data,
|
||||
headers=headers,
|
||||
)
|
||||
return DeckLabel(**response.json())
|
||||
|
||||
async def update_label(
|
||||
self,
|
||||
board_id: int,
|
||||
label_id: int,
|
||||
title: Optional[str] = None,
|
||||
color: Optional[str] = None,
|
||||
) -> None:
|
||||
json_data = {}
|
||||
if title is not None:
|
||||
json_data["title"] = title
|
||||
if color is not None:
|
||||
json_data["color"] = color
|
||||
await self._make_request(
|
||||
"PUT",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/labels/{label_id}",
|
||||
json=json_data,
|
||||
)
|
||||
|
||||
async def delete_label(self, board_id: int, label_id: int) -> None:
|
||||
await self._make_request(
|
||||
"DELETE", f"/apps/deck/api/v1.0/boards/{board_id}/labels/{label_id}"
|
||||
)
|
||||
|
||||
# Attachments
|
||||
async def get_attachments(
|
||||
self, board_id: int, stack_id: int, card_id: int
|
||||
) -> List[DeckAttachment]:
|
||||
response = await self._make_request(
|
||||
"GET",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}/cards/{card_id}/attachments",
|
||||
)
|
||||
return [DeckAttachment(**attachment) for attachment in response.json()]
|
||||
|
||||
async def get_attachment_file(
|
||||
self, board_id: int, stack_id: int, card_id: int, attachment_id: int
|
||||
) -> Any:
|
||||
# This endpoint returns the raw file, so we return the raw response content
|
||||
response = await self._make_request(
|
||||
"GET",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}/cards/{card_id}/attachments/{attachment_id}",
|
||||
)
|
||||
return response.content
|
||||
|
||||
async def upload_attachment(
|
||||
self,
|
||||
board_id: int,
|
||||
stack_id: int,
|
||||
card_id: int,
|
||||
file_data: bytes,
|
||||
file_type: str = "file",
|
||||
) -> DeckAttachment:
|
||||
# The API expects binary data directly, not JSON
|
||||
headers = {"Content-Type": "application/octet-stream"}
|
||||
params = {"type": file_type}
|
||||
response = await self._make_request(
|
||||
"POST",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}/cards/{card_id}/attachments",
|
||||
headers=headers,
|
||||
params=params,
|
||||
data=file_data,
|
||||
)
|
||||
return DeckAttachment(**response.json())
|
||||
|
||||
async def update_attachment(
|
||||
self,
|
||||
board_id: int,
|
||||
stack_id: int,
|
||||
card_id: int,
|
||||
attachment_id: int,
|
||||
file_data: bytes,
|
||||
file_type: str = "deck_file",
|
||||
) -> DeckAttachment:
|
||||
headers = {"Content-Type": "application/octet-stream"}
|
||||
params = {"type": file_type}
|
||||
response = await self._make_request(
|
||||
"PUT",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}/cards/{card_id}/attachments/{attachment_id}",
|
||||
headers=headers,
|
||||
params=params,
|
||||
data=file_data,
|
||||
)
|
||||
return DeckAttachment(**response.json())
|
||||
|
||||
async def delete_attachment(
|
||||
self, board_id: int, stack_id: int, card_id: int, attachment_id: int
|
||||
) -> None:
|
||||
await self._make_request(
|
||||
"DELETE",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}/cards/{card_id}/attachments/{attachment_id}",
|
||||
)
|
||||
|
||||
async def restore_attachment(
|
||||
self, board_id: int, stack_id: int, card_id: int, attachment_id: int
|
||||
) -> None:
|
||||
await self._make_request(
|
||||
"PUT",
|
||||
f"/apps/deck/api/v1.0/boards/{board_id}/stacks/{stack_id}/cards/{card_id}/attachments/{attachment_id}/restore",
|
||||
)
|
||||
|
||||
# OCS API Endpoints (Config, Comments, Sessions)
|
||||
async def get_config(self) -> DeckConfig:
|
||||
headers = {"OCS-APIRequest": "true", "Accept": "application/json"}
|
||||
response = await self._make_request(
|
||||
"GET", "/ocs/v2.php/apps/deck/api/v1.0/config", headers=headers
|
||||
)
|
||||
return DeckConfig(**response.json()["ocs"]["data"])
|
||||
|
||||
async def set_config_value(
|
||||
self, key: str, value: Any, board_id: Optional[int] = None
|
||||
) -> Any:
|
||||
path = f"/ocs/v2.php/apps/deck/api/v1.0/config/{key}"
|
||||
if board_id:
|
||||
path = f"/ocs/v2.php/apps/deck/api/v1.0/config/board:{board_id}:{key}"
|
||||
json_data = {"value": value}
|
||||
response = await self._make_request(
|
||||
"POST",
|
||||
path,
|
||||
json=json_data,
|
||||
headers={"OCS-APIRequest": "true", "Accept": "application/json"},
|
||||
)
|
||||
return response.json()["ocs"]["data"]
|
||||
|
||||
async def get_comments(
|
||||
self, card_id: int, limit: int = 20, offset: int = 0
|
||||
) -> List[DeckComment]:
|
||||
params = {"limit": limit, "offset": offset}
|
||||
response = await self._make_request(
|
||||
"GET",
|
||||
f"/ocs/v2.php/apps/deck/api/v1.0/cards/{card_id}/comments",
|
||||
params=params,
|
||||
headers={"OCS-APIRequest": "true", "Accept": "application/json"},
|
||||
)
|
||||
return [DeckComment(**comment) for comment in response.json()["ocs"]["data"]]
|
||||
|
||||
async def create_comment(
|
||||
self, card_id: int, message: str, parent_id: Optional[int] = None
|
||||
) -> DeckComment:
|
||||
json_data = {"message": message}
|
||||
if parent_id is not None:
|
||||
json_data["parentId"] = parent_id
|
||||
response = await self._make_request(
|
||||
"POST",
|
||||
f"/ocs/v2.php/apps/deck/api/v1.0/cards/{card_id}/comments",
|
||||
json=json_data,
|
||||
headers={"OCS-APIRequest": "true", "Accept": "application/json"},
|
||||
)
|
||||
return DeckComment(**response.json()["ocs"]["data"])
|
||||
|
||||
async def update_comment(
|
||||
self, card_id: int, comment_id: int, message: str
|
||||
) -> DeckComment:
|
||||
json_data = {"message": message}
|
||||
response = await self._make_request(
|
||||
"PUT",
|
||||
f"/ocs/v2.php/apps/deck/api/v1.0/cards/{card_id}/comments/{comment_id}",
|
||||
json=json_data,
|
||||
headers={"OCS-APIRequest": "true", "Accept": "application/json"},
|
||||
)
|
||||
return DeckComment(**response.json()["ocs"]["data"])
|
||||
|
||||
async def delete_comment(self, card_id: int, comment_id: int) -> None:
|
||||
await self._make_request(
|
||||
"DELETE",
|
||||
f"/ocs/v2.php/apps/deck/api/v1.0/cards/{card_id}/comments/{comment_id}",
|
||||
headers={"OCS-APIRequest": "true", "Accept": "application/json"},
|
||||
)
|
||||
|
||||
async def create_session(self, board_id: int) -> DeckSession:
|
||||
json_data = {"boardId": board_id}
|
||||
response = await self._make_request(
|
||||
"PUT",
|
||||
"/ocs/v2.php/apps/deck/api/v1.0/session/create",
|
||||
json=json_data,
|
||||
headers={"OCS-APIRequest": "true", "Accept": "application/json"},
|
||||
)
|
||||
return DeckSession(**response.json()["ocs"]["data"])
|
||||
|
||||
async def sync_session(self, board_id: int, token: str) -> None:
|
||||
json_data = {"boardId": board_id, "token": token}
|
||||
await self._make_request(
|
||||
"POST",
|
||||
"/ocs/v2.php/apps/deck/api/v1.0/session/sync",
|
||||
json=json_data,
|
||||
headers={"OCS-APIRequest": "true", "Accept": "application/json"},
|
||||
)
|
||||
|
||||
async def close_session(self, board_id: int, token: str) -> None:
|
||||
json_data = {"boardId": board_id, "token": token}
|
||||
await self._make_request(
|
||||
"POST",
|
||||
"/ocs/v2.php/apps/deck/api/v1.0/session/close",
|
||||
json=json_data,
|
||||
headers={"OCS-APIRequest": "true", "Accept": "application/json"},
|
||||
)
|
||||
@@ -0,0 +1,183 @@
|
||||
from datetime import datetime
|
||||
from typing import List, Optional, Dict, Any, Union
|
||||
|
||||
from pydantic import BaseModel, Field, field_validator
|
||||
|
||||
from .base import BaseResponse, StatusResponse
|
||||
|
||||
|
||||
class DeckUser(BaseModel):
|
||||
primaryKey: str
|
||||
uid: str
|
||||
displayname: str
|
||||
|
||||
|
||||
class DeckPermissions(BaseModel):
|
||||
PERMISSION_READ: bool
|
||||
PERMISSION_EDIT: bool
|
||||
PERMISSION_MANAGE: bool
|
||||
PERMISSION_SHARE: bool
|
||||
|
||||
|
||||
class DeckLabel(BaseModel):
|
||||
id: int
|
||||
title: str
|
||||
color: str
|
||||
boardId: Optional[int] = None
|
||||
cardId: Optional[int] = None
|
||||
|
||||
|
||||
class DeckACL(BaseModel):
|
||||
id: int
|
||||
participant: DeckUser
|
||||
type: int
|
||||
boardId: int
|
||||
permissionEdit: bool
|
||||
permissionShare: bool
|
||||
permissionManage: bool
|
||||
owner: bool
|
||||
|
||||
|
||||
class DeckBoardSettings(BaseModel):
|
||||
calendar: bool
|
||||
cardDetailsInModal: Optional[bool] = Field(default=None, alias="cardDetailsInModal")
|
||||
cardIdBadge: Optional[bool] = Field(default=None, alias="cardIdBadge")
|
||||
groupLimit: Optional[List[Dict[str, str]]] = Field(default=None, alias="groupLimit")
|
||||
notify_due: Optional[str] = Field(default=None, alias="notify-due")
|
||||
|
||||
|
||||
class DeckBoard(BaseModel):
|
||||
id: int
|
||||
title: str
|
||||
owner: DeckUser
|
||||
color: str
|
||||
archived: bool
|
||||
labels: List[DeckLabel]
|
||||
acl: List[DeckACL]
|
||||
permissions: DeckPermissions
|
||||
users: List[DeckUser]
|
||||
deletedAt: int
|
||||
lastModified: Optional[int] = None
|
||||
settings: Optional[DeckBoardSettings] = None
|
||||
etag: Optional[str] = Field(default=None, alias="ETag")
|
||||
|
||||
@field_validator("settings", mode="before")
|
||||
@classmethod
|
||||
def validate_settings(cls, v):
|
||||
# Handle case where API returns empty array instead of dict/null
|
||||
if isinstance(v, list) and len(v) == 0:
|
||||
return None
|
||||
return v
|
||||
|
||||
|
||||
class DeckCard(BaseModel):
|
||||
id: int
|
||||
title: str
|
||||
stackId: int
|
||||
type: str
|
||||
order: int
|
||||
archived: bool
|
||||
owner: Union[str, DeckUser] # Can be either string or user object
|
||||
description: Optional[str] = None
|
||||
duedate: Optional[datetime] = None
|
||||
done: Optional[datetime] = None
|
||||
lastModified: Optional[int] = None
|
||||
createdAt: Optional[int] = None
|
||||
labels: Optional[List[DeckLabel]] = None
|
||||
assignedUsers: Optional[List[DeckUser]] = None
|
||||
attachments: Optional[List[Any]] = None # Define a proper Attachment model later
|
||||
attachmentCount: Optional[int] = None
|
||||
deletedAt: Optional[int] = None
|
||||
commentsUnread: Optional[int] = None
|
||||
overdue: Optional[int] = None
|
||||
etag: Optional[str] = Field(default=None, alias="ETag")
|
||||
|
||||
@field_validator("owner", mode="before")
|
||||
@classmethod
|
||||
def validate_owner(cls, v):
|
||||
# Handle case where API returns user object instead of string
|
||||
if isinstance(v, dict):
|
||||
return v.get("uid", v.get("primaryKey", str(v)))
|
||||
return v
|
||||
|
||||
|
||||
class DeckStack(BaseModel):
|
||||
id: int
|
||||
title: str
|
||||
boardId: int
|
||||
order: int
|
||||
deletedAt: int
|
||||
lastModified: Optional[int] = None
|
||||
cards: Optional[List[DeckCard]] = None
|
||||
etag: Optional[str] = Field(default=None, alias="ETag")
|
||||
|
||||
|
||||
class DeckAttachmentExtendedData(BaseModel):
|
||||
filesize: int
|
||||
mimetype: str
|
||||
info: Dict[str, str]
|
||||
|
||||
|
||||
class DeckAttachment(BaseModel):
|
||||
id: int
|
||||
cardId: int
|
||||
type: str
|
||||
data: str
|
||||
lastModified: int
|
||||
createdAt: int
|
||||
createdBy: str
|
||||
deletedAt: int
|
||||
extendedData: DeckAttachmentExtendedData
|
||||
|
||||
|
||||
class DeckComment(BaseModel):
|
||||
id: int
|
||||
objectId: int
|
||||
message: str
|
||||
actorId: str
|
||||
actorType: str
|
||||
actorDisplayName: str
|
||||
creationDateTime: datetime
|
||||
mentions: List[Dict[str, str]]
|
||||
replyTo: Optional[Any] = None # Self-referencing, handle later if needed
|
||||
|
||||
|
||||
class DeckSession(BaseModel):
|
||||
token: str
|
||||
|
||||
|
||||
class DeckConfig(BaseModel):
|
||||
calendar: bool
|
||||
cardDetailsInModal: bool
|
||||
cardIdBadge: bool
|
||||
groupLimit: Optional[List[Dict[str, str]]] = None
|
||||
|
||||
|
||||
# Response Models for MCP Tools
|
||||
|
||||
|
||||
class ListBoardsResponse(BaseResponse):
|
||||
"""Response model for listing deck boards."""
|
||||
|
||||
boards: List[DeckBoard] = Field(description="List of deck boards")
|
||||
total: int = Field(description="Total number of boards")
|
||||
|
||||
|
||||
class CreateBoardResponse(BaseResponse):
|
||||
"""Response model for board creation."""
|
||||
|
||||
id: int = Field(description="The created board ID")
|
||||
title: str = Field(description="The created board title")
|
||||
color: str = Field(description="The created board color")
|
||||
|
||||
|
||||
class GetBoardResponse(BaseResponse):
|
||||
"""Response model for getting board details."""
|
||||
|
||||
board: DeckBoard = Field(description="Board details")
|
||||
|
||||
|
||||
class BoardOperationResponse(StatusResponse):
|
||||
"""Response model for board operations like update/delete."""
|
||||
|
||||
board_id: int = Field(description="ID of the affected board")
|
||||
@@ -3,11 +3,13 @@ from .notes import configure_notes_tools
|
||||
from .tables import configure_tables_tools
|
||||
from .webdav import configure_webdav_tools
|
||||
from .contacts import configure_contacts_tools
|
||||
from .deck import configure_deck_tools
|
||||
|
||||
__all__ = [
|
||||
"configure_calendar_tools",
|
||||
"configure_contacts_tools",
|
||||
"configure_deck_tools",
|
||||
"configure_notes_tools",
|
||||
"configure_tables_tools",
|
||||
"configure_webdav_tools",
|
||||
"configure_contacts_tools",
|
||||
]
|
||||
|
||||
@@ -0,0 +1,76 @@
|
||||
import logging
|
||||
from typing import Optional
|
||||
|
||||
from mcp.server.fastmcp import Context, FastMCP
|
||||
|
||||
from nextcloud_mcp_server.client import NextcloudClient
|
||||
from nextcloud_mcp_server.models.deck import (
|
||||
ListBoardsResponse,
|
||||
CreateBoardResponse,
|
||||
GetBoardResponse,
|
||||
)
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
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()
|
||||
client: NextcloudClient = ctx.request_context.lifespan_context.client
|
||||
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()
|
||||
client: NextcloudClient = ctx.request_context.lifespan_context.client
|
||||
board = await client.deck.get_board(board_id)
|
||||
return board.model_dump()
|
||||
|
||||
# Tools
|
||||
@mcp.tool()
|
||||
async def deck_list_boards(
|
||||
ctx: Context, details: bool = False, if_modified_since: Optional[str] = None
|
||||
) -> ListBoardsResponse:
|
||||
"""List all Nextcloud Deck boards
|
||||
|
||||
Args:
|
||||
details: Enhance boards with details about labels, stacks and users
|
||||
if_modified_since: Limit results to entities changed after this time (IMF-fixdate format)
|
||||
"""
|
||||
client: NextcloudClient = ctx.request_context.lifespan_context.client
|
||||
boards = await client.deck.get_boards(
|
||||
details=details, if_modified_since=if_modified_since
|
||||
)
|
||||
return ListBoardsResponse(boards=boards, total=len(boards))
|
||||
|
||||
@mcp.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: NextcloudClient = ctx.request_context.lifespan_context.client
|
||||
board = await client.deck.create_board(title, color)
|
||||
return CreateBoardResponse(id=board.id, title=board.title, color=board.color)
|
||||
|
||||
@mcp.tool()
|
||||
async def deck_get_board(ctx: Context, board_id: int) -> GetBoardResponse:
|
||||
"""Get details of a specific Nextcloud Deck board
|
||||
|
||||
Args:
|
||||
board_id: The ID of the board
|
||||
"""
|
||||
client: NextcloudClient = ctx.request_context.lifespan_context.client
|
||||
board = await client.deck.get_board(board_id)
|
||||
return GetBoardResponse(board=board)
|
||||
Reference in New Issue
Block a user