Skip to main content
Glama
davidharutyunyan

Archicad MCP Connector

Reserve (Teamwork)

reserve_elements
DestructiveIdempotent

Reserve Archicad Teamwork elements and object sets before editing, so you can lock what you need and see conflicts or the current owner. Returns reservation status; no effect in solo projects.

Instructions

Teamwork: reserves elements and/or object sets so you can edit them (elements reserved by someone else cannot be taken; the result names the owner). Output: {isTeamwork: true, elements?: [{guid, status, reserved, conflictWith?, reservedBy?} | {error}], objectSets?: [{name, status, reserved, apiError?, conflictWith?}], warning?}. Check get_teamwork_status first. In a solo (non-Teamwork) project this does nothing and returns {isTeamwork: false, message} — that is not an error: everything is editable without reservation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
elementsNoElements to reserve/release (GUIDs)
objectSetsNoObject sets to reserve/release: needed before editing attributes (e.g. 'Composites' before modifying composites, 'LayerSettings' for layers), favorites, project info or project preferences in Teamwork
enableDialogsNoLet Archicad show its own Teamwork dialogs (e.g. request/conflict messages). Default false
hotlinkCacheManagementNoAlso reserve/release Hotlink Cache Management (needed to update/relink hotlinks)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.4/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructive/idempotent/readOnly, and the description adds substantial context beyond them: the conflict rule with the other owner, the per-item status/conflictWith/reservedBy result shape, and the explicit warning that a solo project returns {isTeamwork: false} rather than failing. That is exactly the behavioral disclosure an agent needs before locking elements.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads purpose, then behavior, then the return shape, then the prerequisite, then the solo-project caveat. The inline output listing is somewhat dense but is justified because no output schema is supplied. No filler sentences.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description compensates by spelling out the return object including per-element errors and the warning field, and it covers the no-op case. Combined with the annotations' safety profile, an agent has everything needed to call and interpret this correctly. Only the two boolean parameters remain unexplained.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents elements, objectSets (with the full enum listing), enableDialogs and hotlinkCacheManagement. The description only restates the objectSets examples ('Composites', 'LayerSettings') and never explains enableDialogs or hotlinkCacheManagement, so it adds little beyond the schema. Baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a precise verb+resource ('reserves elements and/or object sets') and immediately states the intent ('so you can edit them'), which clearly separates it from release_elements among the siblings. The conflict rule ('elements reserved by someone else cannot be taken; the result names the owner') further pins down the exact semantics.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit prerequisite ('Check get_teamwork_status first') named by sibling, plus a valuable when-not-to-use case (solo non-Teamwork projects are a no-op, not an error). It stops short of contrasting with release_elements or stating when reservation is unnecessary, so it is clear context without full alternative routing.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools