Skip to main content
Glama
AFAS MCP Server

AFAS MCP Server

Describe a GetConnector

afas_describe_get_connector
Read-onlyIdempotent

Retrieves a GetConnector’s schema—field IDs, labels, data types, and lengths—so you can use valid IDs in filters and order_by.

Instructions

Describe a GetConnector: its field ids, labels, data types and lengths. Use the ids in filters and order_by.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "connector_id": "<connector_id>"
    },
    "name": "afas_describe_get_connector"
  }
}

Input Schema

NameRequiredDescriptionDefault
connector_idYesConnector id as listed by afas_list_connectors, e.g. Profit_Employees.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

The annotations already declare that the tool is read-only, idempotent, open-world, and non-destructive. The description adds useful behavioral context by stating that it returns field ids, labels, data types, and lengths. It does not discuss auth or rate limits, but those gaps are minor given the annotations and output schema.

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 short sentences with no wasted wording. It front-loads the core purpose and follows with practical guidance on using the returned ids.

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

Completeness4/5

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

For a simple read-only introspection tool with one required parameter, rich annotations, and an output schema, the description covers the essential purpose and output usage. It could be more complete by clarifying its relationship to the sibling describe_update_connector tool.

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%, and the connector_id parameter is fully documented with an example and a reference to afas_list_connectors. The description itself does not add meaning about connector_id beyond what the schema already provides, so the baseline 3 is appropriate.

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

Purpose4/5

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

The description states a specific verb and resource: 'Describe a GetConnector'. It also lists the returned field metadata, making the tool's purpose clear. It does not explicitly distinguish itself from the sibling afas_describe_update_connector, so it falls short of a 5.

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 phrase 'Use the ids in filters and order_by' gives downstream usage guidance, implying this tool is used before row retrieval. However, it does not say when to choose this tool over afas_list_connectors or afas_describe_update_connector, so usage is only implied.

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