Skip to main content
Glama

add_elements

Add multiple ArchiMate elements to the active model with one call. Specify type, name, and optional details like ID, description, or folder path. Roll back on error to preserve model state.

Instructions

Add multiple elements to the active model in one call.

Each element item supports the same fields as `add_element`. Both
short and long field names are accepted (`type` or `element_type`,
`id` or `element_id`).

IDs are unique across the **entire active model**, not per call,
per batch, or per concept type. Splitting a build across several
batches does not give each batch its own id space, so namespace
generated ids (`bp-`, `ac-`, `tech-`) rather than restarting the
same naming pattern in each one.

Element item shape:
    ```
    {
      "id": "id-customer",        # optional stable ref
      "name": "Customer",          # required
      "type": "BusinessActor",     # required (alias: element_type)
      "description": "...",       # optional
      "folder_path": "/Business", # optional
      "properties": {"k": "v"}     # optional
    }
    ```

Args:
    elements: List of element item objects.
    rollback_on_error: When true (default), restore the previous
        model state if any item fails. Set to false to keep partial
        results.

Returns:
    Success envelope with `data.elements` (list of `ElementDetail`),
    `data.count`, and `data.rollback_on_error`.

Errors:
    `ModelNotFoundError`, `InvalidElementTypeError`,
    `ModelOperationError` for the first failing item.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
elementsYes
rollback_on_errorNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior5/5

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

Annotations indicate readOnlyHint=false (write), destructiveHint=false, openWorldHint=false. The description adds critical behavioral context: rollback_on_error restores state, IDs are unique across the model, and error behavior stops at first failure. There is no contradiction with annotations.

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?

The description is well-structured with sections for description, args, returns, and errors. It front-loads key purpose details. It is slightly verbose with the element item shape example but remains focused and informative.

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?

The tool has 2 parameters, no schema descriptions, but has an output schema mentioned. The description covers returns (data.elements, count, rollback_on_error) and specific error types. For a batch operation with rollback, this is a complete and self-contained description.

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

Parameters5/5

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

Schema coverage is 0%, so description carries full burden. It thoroughly explains the `elements` parameter structure, field aliases (type/element_type, id/element_id), required fields, and the `rollback_on_error` default. This adds substantial meaning beyond the schema's minimal definitions.

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?

The description clearly states it adds multiple elements to the active model in one call. It distinguishes from the sibling tool `add_element` by noting it supports the same fields for each item but allows multiple items at once, making the purpose specific and distinguishable.

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?

The description provides explicit guidance on ID uniqueness across the entire model, warning against reusing naming patterns across batches. It also mentions the rollback behavior and error handling. While it does not explicitly state when not to use this tool versus `add_element`, the context of batch addition is clear.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/byrondelgado/mcp-archimate'

If you have feedback or need assistance with the MCP directory API, please join our Discord server