Skip to main content
Glama
ohneben

ActiveCampaign MCP

retrieve_a_schema

Read-onlyIdempotent

Retrieve a specific custom object schema by its ID. Optionally include all fields, including deleted, using showFields parameter.

Instructions

🟢 READ-ONLY · Custom Objects · GET /customObjects/schemas/{id}

Retrieve a schema

Fetches data. Makes no changes to your ActiveCampaign account.

Retrieve a specific schema by id.

Users are encouraged to leverage the ?showFields=all query parameter when programmatically creating new schema fields, to ensure field id uniqueness. Fields that have been deleted will contain a status: marked_for_deletion attribute.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesId of the Schema
showFieldsNoToggle which fields are shown in the response body of a schema (if there hidden due to e.g. recently being deleted). Omit this parameter entirely to hide fields by default.all
Behavior4/5

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

Annotations already declare readOnly and idempotent. The description adds the HTTP method (GET), states 'Fetches data. Makes no changes', and explains the behavior of the showFields parameter (e.g., deleted fields show 'status: marked_for_deletion'). No contradictions.

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 fairly concise with two main parts: a header and a usage tip. There is slight repetition of 'Retrieve a schema' but overall it is well-structured and not overly verbose.

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

Completeness3/5

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

For a simple retrieval tool, the description covers the main behavior and parameter usage. However, it lacks details about error responses, output structure (no output schema), or edge cases. Adequate but not exhaustive.

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 coverage is 100%, so baseline is 3. The description adds a usage tip for showFields but does not add new semantic meaning beyond the schema descriptions. For the id parameter, no additional context is provided.

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 the tool retrieves a schema by ID. The verb 'retrieve' and resource 'schema' are specific, and it distinguishes from sibling tools like list_all_schemas (list all) and create/update/delete schemas.

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

Usage Guidelines3/5

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

The description includes a usage tip for the showFields parameter but does not provide guidance on when to use this tool versus alternative tools like list_all_schemas. Basic usage is implied but no explicit when-to-use or when-not-to-use.

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/ohneben/ActiveCampaign-MCP'

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