Skip to main content
Glama
SzamosiMate

tapir-archicad-mcp

by SzamosiMate

List Active Archicad Instances

discovery_list_active_archicads
Read-onlyIdempotent

Scan for running Archicad instances and identify active ones with their target ports, plus any unavailable instances missing the Tapir Add-On.

Instructions

Scans for and lists running Archicad instances. Returns 'active' (ready to receive commands with their target 'port') and 'unavailable' (instances that are unresponsive or missing the Tapir Add-On).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
activeInstancesNoList of ready Archicad instances that can be targeted by commands.
unavailableInstancesNoList of detected instances that cannot be targeted, along with diagnostic reasons.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv0.6.0
    • removedOutput schema / $defs / ArchicadInstanceInfo
      Removed value: -{
      -  "description": "A curated model to hold key information about a running Archicad instance.",
      -  "properties": {
      -    "archicadVersion": {
      -      "description": "The major version of the Archicad application (e.g., '27').",
      -      "title": "Archicadversion",
      -      "type": "string"
      -    },
      -    "port": {
      -      "description": "The communication port of the Archicad instance. Use this to target commands.",
      -      "title": "Port",
      -      "type": "integer"
      -    },
      -    "projectName": {
      -      "description": "The name of the project file currently open in the instance.",
      -      "title": "Projectname",
      -      "type": "string"
      -    },
      -    "projectPath": {
      -      "anyOf": [
      -        {
      -          "type": "string"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ],
      -      "default": null,
      -      "description": "The full file path of the project, if it is a saved solo or teamwork project.",
      -      "title": "Projectpath"
      -    },
      -    "projectType": {
      -      "description": "The type of the project: 'teamwork', 'solo', or 'untitled'.",
      -      "enum": [
      -        "teamwork",
      -        "solo",
      -        "untitled"
      -      ],
      -      "title": "Projecttype",
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "port",
      -    "projectName",
      -    "projectType",
      -    "archicadVersion"
      -  ],
      -  "title": "ArchicadInstanceInfo",
      -  "type": "object"
      -}
    • addedOutput schema / $defs / ReadyInstance
      Added value: +{
      +  "description": "Information about an active Archicad instance ready to execute commands.",
      +  "properties": {
      +    "archicadVersion": {
      +      "description": "The major version of Archicad (e.g. '27', '28').",
      +      "title": "Archicadversion",
      +      "type": "string"
      +    },
      +    "port": {
      +      "description": "The communication port of the Archicad instance. Pass this to archicad_call_tool.",
      +      "title": "Port",
      +      "type": "integer"
      +    },
      +    "projectName": {
      +      "description": "The name of the currently open project.",
      +      "title": "Projectname",
      +      "type": "string"
      +    },
      +    "projectPath": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "description": "The full file path or teamwork server location of the project.",
      +      "title": "Projectpath"
      +    },
      +    "projectType": {
      +      "description": "The type of the project: 'teamwork', 'solo', or 'untitled'.",
      +      "enum": [
      +        "teamwork",
      +        "solo",
      +        "untitled"
      +      ],
      +      "title": "Projecttype",
      +      "type": "string"
      +    },
      +    "tapirVersion": {
      +      "description": "The version of the Tapir Add-On installed on this instance.",
      +      "title": "Tapirversion",
      +      "type": "string"
      +    },
      +    "warning": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "description": "Warning regarding Tapir version differences (e.g., outdated or newer version).",
      +      "title": "Warning"
      +    }
      +  },
      +  "required": [
      +    "port",
      +    "projectName",
      +    "projectType",
      +    "archicadVersion",
      +    "tapirVersion"
      +  ],
      +  "title": "ReadyInstance",
      +  "type": "object"
      +}
    • addedOutput schema / $defs / UnavailableInstance
      Added value: +{
      +  "description": "Diagnostic information about an Archicad instance that cannot be automated.",
      +  "properties": {
      +    "message": {
      +      "description": "Explanation and actionable troubleshooting advice.",
      +      "title": "Message",
      +      "type": "string"
      +    },
      +    "reason": {
      +      "description": "Why the instance is unavailable: 'missing_tapir' or 'unresponsive'.",
      +      "enum": [
      +        "missing_tapir",
      +        "unresponsive"
      +      ],
      +      "title": "Reason",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "reason",
      +    "message"
      +  ],
      +  "title": "UnavailableInstance",
      +  "type": "object"
      +}
    • addedOutput schema / description
      Added value: +"The result of scanning for Archicad instances."
    • addedOutput schema / properties / activeInstances
      Added value: +{
      +  "description": "List of ready Archicad instances that can be targeted by commands.",
      +  "items": {
      +    "$ref": "#/$defs/ReadyInstance"
      +  },
      +  "title": "Activeinstances",
      +  "type": "array"
      +}
    • removedOutput schema / properties / result
      Removed value: -{
      -  "items": {
      -    "$ref": "#/$defs/ArchicadInstanceInfo"
      -  },
      -  "title": "Result",
      -  "type": "array"
      -}
    • addedOutput schema / properties / unavailableInstances
      Added value: +{
      +  "description": "List of detected instances that cannot be targeted, along with diagnostic reasons.",
      +  "items": {
      +    "$ref": "#/$defs/UnavailableInstance"
      +  },
      +  "title": "Unavailableinstances",
      +  "type": "array"
      +}
    • removedOutput schema / required
      Removed value: -[
      -  "result"
      -]
    • changedOutput schema / title
      Previous value: -"list_active_archicadsOutput"New value: +"DiscoveryResult"
  2. First observedv0.4.3

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare read-only, open-world, idempotent, and non-destructive behavior, so the description does not need to repeat those. It adds valuable behavioral context by explaining what 'active' means, that ports are provided, and that 'unavailable' instances may be unresponsive or missing the Tapir Add-On. 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?

The description is two concise sentences with no filler. The core action is front-loaded, and the second sentence adds meaningful output clarification without redundancy.

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?

For a simple, parameterless discovery tool with safety annotations and an output schema, the description is complete. It explains what the tool returns, what the categories mean, and why an instance might be unavailable, which is all an agent needs to select and interpret the tool correctly.

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?

The tool has zero parameters, so the schema provides no parameter details to supplement. The description correctly focuses on behavior and return categories instead, which is appropriate for a parameterless discovery tool.

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 states a specific verb ('Scans for and lists') and resource ('running Archicad instances'), making the tool's function immediately clear. It also goes beyond a simple label by explaining the two output categories, 'active' and 'unavailable', which distinguishes it from sibling tools that deal with commands and schemas.

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 makes the usage context clear: it identifies which instances are ready to receive commands and provides their target ports, implying it should be used before calling command-execution tools. It does not explicitly name alternatives or state when not to use it, but the intended role is evident from the active/unavailable distinction.

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