Skip to main content
Glama

update_element

Idempotent

Update an existing ArchiMate element by ID, modifying its name, description, folder path, or properties.

Instructions

Update an existing ArchiMate element.

Updates is a dict containing only the fields to change. Other fields
are left untouched. Properties are merged into existing properties
(use an empty value to clear a key on subsequent updates).

Args:
    element_id: ID of the element to update.
    updates: Mapping of fields to update. Supported keys:
        - `name` (str): New element name.
        - `description` (str): New documentation text.
        - `folder_path` (str): New folder path; folder root must
          match the element's ArchiMate category.
        - `properties` (dict[str, str]): Property updates merged
          into existing properties.
        Element type cannot be changed; recreate the element to
        change its type.

Returns:
    Success envelope with the updated `ElementDetail` in `data`.

Errors:
    `ElementNotFoundError` when `element_id` is unknown.
    `ModelOperationError` for invalid folder paths.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
updatesYes
element_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior5/5

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

Discloses key behaviors beyond annotations: updates are partial (only specified fields change), properties merge with existing (use empty to clear), folder path must match category, and element type immutability. 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.

Conciseness5/5

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

Well-structured with Args, Returns, Errors sections. Each sentence adds value; no fluff. Length appropriate for the tool's complexity.

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?

Covers all important aspects: partial update semantics, property merging rules, folder path constraint, type immutability, return type, and specific error cases. Output schema exists but description still summarizes return value.

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

Parameters4/5

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

Schema has 0% description coverage, so description fully compensates. Explains updates dict structure, lists supported keys with types and constraints, and describes element_id usage. Adds meaning beyond the bare schema.

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?

Clearly states 'Update an existing ArchiMate element' with specific verb and resource. Differentiates from sibling tools like add_element and delete_element by explicitly noting element type cannot be changed, leaving recreation as alternative.

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?

Provides guidance on partial updates via updates dict and property merging. Mentions when to recreate instead of update for type changes. However, lacks explicit comparison to sibling update tools like update_model.

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