Skip to main content
Glama

provider_test_ldap

Validates LDAP connection and custom settings by testing user or group searches, confirming the configuration works before use.

Instructions

Tests LDAP Connection and Settings Tests that custom LDAP settings are valid, and that the system can use them to search for a user or group POST /cloudapi/1.0.0/ldap/test

Input Schema

NameRequiredDescriptionDefault
bodyYesLDAP Settings Specification — LDAP Settings to use for testing connection
usernameNoUsername to use when testing LDAP search

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false, and openWorldHint=true, so the safety profile is covered. The description usefully discloses that it exercises an external LDAP server by performing a user/group search, which explains the openWorld flag. However, it says nothing about credential requirements, whether any state is modified, or what a failed test returns; the POST endpoint does not contradict the annotations since destructive is false.

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?

Three short lines, front-loaded with the action and its validation purpose, followed by the endpoint. Minor redundancy between the title line 'Tests LDAP Connection and Settings' and the following 'Tests that custom LDAP settings are valid' phrase, but nothing extraneous beyond that.

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?

There is no output schema, and for a test/validation tool the return semantics (boolean pass/fail vs. error detail vs. sample search results) matter to an agent interpreting the outcome. The description covers intent and the external-search behavior but leaves the result contract and any prerequisites unstated. Adequate but with a clear gap for this tool type.

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%, with the body and username documented in the schema (the body spec includes nested userAttributes/groupAttributes descriptions). The description adds no parameter-level meaning — in particular it does not flag which settings are essential for a successful test versus optional tuning (pageSize, maxResults, pagedSearchDisabled). Baseline 3 applies when the schema carries the semantics.

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?

States a specific verb and resource: it validates LDAP connection settings and verifies the system can search for a user or group, plus the endpoint. This clearly distinguishes it from CRUD siblings like provider_update_org_ldap_settings. It does not explicitly contrast with near neighbors such as provider_search_ldap_users, provider_sync_ldap, or provider_test, 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 use case (validate custom LDAP settings before relying on them) is implied by 'Tests that custom LDAP settings are valid', but there is no explicit when-to-use/when-not guidance or named alternative such as provider_search_ldap_users for an actual search. An agent must infer it is a pre-flight validation call.

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

Deploy Server

Other Tools