Skip to main content
Glama

API reference for a resource

docuflex_api_reference

List the operations (method, path, summary) for one resource group from the OpenAPI spec: envelopes, signing, verify, templates, bulk-send, connect, uploads, api-keys, oauth, accounts, library, admin.

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": {
      "resource": "<resource>"
    },
    "name": "docuflex_api_reference"
  }
}

Input Schema

NameRequiredDescriptionDefault
resourceYesTag name, e.g. 'envelopes'

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior3/5

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

With no annotations at all, the description carries the full disclosure burden. It does useful work by revealing the return shape (method, path, summary) despite the absence of an output schema, and 'from the OpenAPI spec' implies a static read-only reference rather than live tenant data. However, it says nothing about failure behavior for an invalid tag, whether the list is paginated or complete, or how fresh the spec is — gaps that matter for a tool with zero annotation coverage.

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?

One sentence, front-loaded with the action and return fields before the value list. The long enumeration is not padding — it supplies the missing enum constraint — so every element earns its place.

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 single-parameter read-only reference lookup, this is close to sufficient: it defines the input domain and the returned fields without needing an output schema. The remaining gap is behavioral edge cases (invalid tag, result size), which are minor but non-zero for a tool with no annotations.

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 coverage is 100%, so the baseline would be 3, but the description goes further by enumerating the full set of accepted tag names (envelopes, signing, verify, templates, bulk-send, connect, uploads, api-keys, oauth, accounts, library, admin). Since the schema declares zero enums, this list is the only place an agent learns the valid values, which is genuine added meaning.

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?

States a specific verb and resource ('List the operations ... for one resource group from the OpenAPI spec') and names exactly what each entry contains: method, path, summary. The enumerated resource groups make the scope concrete, and it is unmistakably a documentation-lookup tool rather than the envelope-manipulation siblings like create_envelope or send_envelope.

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?

Usage is only implied: an agent can infer this is the tool to call when it needs to discover which API operations exist for a resource group. There is no explicit 'use this when...' framing, no guidance on what to do instead for a single known operation, and no note about what happens with an unrecognized resource tag.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources