| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232 |
- """Definition des outils MCP (operations de gestion de groupes)."""
- from __future__ import annotations
- from typing import Annotated, Any
- from pydantic import Field
- from mcp.types import ToolAnnotations
- from ..services.client_rest import ClientRest, HTTPMethod
- _WRITE_ONLY = ToolAnnotations(readOnlyHint=False, destructiveHint=False)
- _WRITE_DESTRUCTIVE = ToolAnnotations(readOnlyHint=False, destructiveHint=True)
- _WRITE_IDEMPOTENT = ToolAnnotations(
- readOnlyHint=False, destructiveHint=True, idempotentHint=True
- )
- # --- createResourceGroup ---
- ResourceGroupName = Annotated[str, Field(description="name of the resource group")]
- AccessAdmin = Annotated[
- bool | None,
- Field(default=None, description="grant the Administrator user group access to the new resource group"),
- ]
- AccessAnon = Annotated[
- bool | None,
- Field(default=None, description="grant anonymous users view access to the new resource group"),
- ]
- AccessParallel = Annotated[
- bool | None,
- Field(default=None, description="create a parallel user group with the same name"),
- ]
- AccessContexts = Annotated[
- str | None,
- Field(default=None, description="comma-separated context keys for access policies"),
- ]
- AccessUserGroups = Annotated[
- str | None,
- Field(default=None, description="comma-separated user group names to grant access"),
- ]
- # --- updateResourceGroup / removeResourceGroup ---
- ResourceGroupId = Annotated[int | str, Field(description="resource group id or name")]
- ResourceIds = Annotated[
- list[int],
- Field(description="array of resource ids, e.g. [12, 45, 78]"),
- ]
- # --- createUserGroup ---
- UserGroupName = Annotated[str, Field(description="user group name to create")]
- UserGroupDescription = Annotated[str | None, Field(default=None, description="user group description")]
- Users = Annotated[
- str | None,
- Field(default=None, description="comma-separated list of username or username:role key pairs"),
- ]
- UserGroupParent = Annotated[int | None, Field(default=None, description="parent of the group")]
- CreateParallelResourceGroup = Annotated[
- str | None,
- Field(
- default=None,
- description="if set, create a parallel resource group with the same name for the user group",
- ),
- ]
- AddResourceGroups = Annotated[
- str | None,
- Field(default=None, description="comma-delimited list of resource group names to add to the user group"),
- ]
- # --- createAccess / updateAccess ---
- UserGroupId = Annotated[int | str, Field(description="user group id or name")]
- AccessPolicy = Annotated[
- int | str | None,
- Field(default=None, description="access policy id or name (default: Resource)"),
- ]
- Authority = Annotated[int | None, Field(default=None, description="authority level (minimum user role required)")]
- ContextKey = Annotated[str | None, Field(default=None, description="context key")]
- # --- updateAccess / removeAccess ---
- AccessId = Annotated[int, Field(description="ACL access entry id")]
- UserGroupIdRemove = Annotated[int, Field(description="user group id")]
- def _omit_none(**kwargs: Any) -> dict[str, Any]:
- return {key: value for key, value in kwargs.items() if value is not None}
- def register_groupmgt_tools(mcp_server: Any, client_rest: ClientRest) -> None:
- """Enregistre les outils de gestion de groupes du serveur MCP."""
- @mcp_server.tool(
- description="Creer un nouveau groupe de ressource.",
- annotations=_WRITE_ONLY,
- )
- def createResourceGroup(
- name: ResourceGroupName,
- accessAdmin: AccessAdmin = None,
- accessAnon: AccessAnon = None,
- accessParallel: AccessParallel = None,
- accessContexts: AccessContexts = None,
- accessUserGroups: AccessUserGroups = None,
- ) -> dict[str, Any]:
- return client_rest.execute(
- method=HTTPMethod.POST,
- endpoint="/rest/groupmgt/resources",
- json=_omit_none(
- name=name,
- accessAdmin=accessAdmin,
- accessAnon=accessAnon,
- accessParallel=accessParallel,
- accessContexts=accessContexts,
- accessUserGroups=accessUserGroups,
- ),
- )
- @mcp_server.tool(
- description="Ajouter des ressources MODX a un groupe de ressource existant.",
- annotations=_WRITE_IDEMPOTENT,
- )
- def updateResourceGroup(
- id: ResourceGroupId,
- resources: ResourceIds,
- ) -> dict[str, Any]:
- return client_rest.execute(
- method=HTTPMethod.PUT,
- endpoint="/rest/groupmgt/resources",
- json={"id": id, "resources": resources},
- )
- @mcp_server.tool(
- description="Retirer des ressources MODX d'un groupe de ressource.",
- annotations=_WRITE_DESTRUCTIVE,
- )
- def removeResourceGroup(
- id: ResourceGroupId,
- resources: ResourceIds,
- ) -> dict[str, Any]:
- return client_rest.execute(
- method=HTTPMethod.DELETE,
- endpoint=f"/rest/groupmgt/resources/{id}",
- params={
- "resources[]": resources
- }
- )
- @mcp_server.tool(
- description="Creer un nouveau groupe d'utilisateur.",
- annotations=_WRITE_ONLY,
- )
- def createUserGroup(
- name: UserGroupName,
- description: UserGroupDescription = None,
- users: Users = None,
- parent: UserGroupParent = None,
- createResourceGroup: CreateParallelResourceGroup = None,
- addResourceGroups: AddResourceGroups = None,
- ) -> dict[str, Any]:
- return client_rest.execute(
- method=HTTPMethod.POST,
- endpoint="/rest/groupmgt/group",
- json=_omit_none(
- name=name,
- description=description,
- users=users,
- parent=parent,
- createResourceGroup=createResourceGroup,
- addResourceGroups=addResourceGroups,
- ),
- )
- @mcp_server.tool(
- description="Creer un acces entre un groupe d'utilisateur et un groupe de ressource.",
- annotations=_WRITE_ONLY,
- )
- def createAccess(
- id: UserGroupId,
- resourceGroup: ResourceGroupId,
- policy: AccessPolicy = None,
- authority: Authority = None,
- context: ContextKey = None,
- ) -> dict[str, Any]:
- return client_rest.execute(
- method=HTTPMethod.POST,
- endpoint="/rest/groupmgt/access",
- json=_omit_none(
- id=id,
- resourceGroup=resourceGroup,
- policy=policy,
- authority=authority,
- context=context,
- ),
- )
- @mcp_server.tool(
- description="Mettre a jour un acces existant entre un groupe d'utilisateur et un groupe de ressource.",
- annotations=_WRITE_IDEMPOTENT,
- )
- def updateAccess(
- id: UserGroupId,
- accessId: AccessId,
- resourceGroup: ResourceGroupId | None = None,
- policy: AccessPolicy = None,
- authority: Authority = None,
- context: ContextKey = None,
- ) -> dict[str, Any]:
- return client_rest.execute(
- method=HTTPMethod.PUT,
- endpoint="/rest/groupmgt/access",
- json=_omit_none(
- id=id,
- accessId=accessId,
- resourceGroup=resourceGroup,
- policy=policy,
- authority=authority,
- context=context,
- ),
- )
- @mcp_server.tool(
- description="Supprimer un acces existant entre un groupe d'utilisateur et un groupe de ressource.",
- annotations=_WRITE_DESTRUCTIVE,
- )
- def removeAccess(
- id: UserGroupIdRemove,
- accessId: AccessId,
- ) -> dict[str, Any]:
- return client_rest.execute(
- method=HTTPMethod.DELETE,
- endpoint=f"/rest/groupmgt/access/{id}",
- params={
- "accessId": accessId
- }
- )
|