Skip to main content
Glama

get_api_spec

Retrieve full technical specifications, parameters, headers, and request/response payloads for an eTIMS API endpoint (OSCU or VSCU) to build and troubleshoot integrations.

Instructions

Get full technical specifications, parameters, headers, and request/response payloads for an eTIMS API endpoint (OSCU or VSCU).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
solutionNoFilter by integration solution typeANY
endpoint_nameYesEndpoint name or partial path (e.g. 'saveTrnsSalesOsdc', 'selectInitOsdcInfo', 'saveItem', 'insertStockIO', 'selectCustomer')

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.4/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It does disclose the return content (parameters, headers, request/response payloads), which is useful, but omits behavior an agent would want: whether endpoint_name is fuzzy/partial-matched, what happens when no endpoint matches, and whether the response is a single spec or a list.

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?

A single front-loaded sentence that lists the returned artifacts in a natural order (specs, parameters, headers, payloads). No filler or redundant restatement of the tool name.

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 read-only, two-parameter lookup with no output schema, the description does the essential work of telling the agent what the response contains. It falls just short on miss-handling and matching semantics, but nothing critical for correct invocation is missing.

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 both parameters documented inline and the solution enum fully spelled out, so the baseline is 3. The description only echoes the OSCU/VSCU distinction already present in the enum and adds no new detail such as expected casing or matching rules for endpoint_name.

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 (Get) and resource (technical specifications for an eTIMS API endpoint), enumerating what is returned: parameters, headers, and request/response payloads. It is clearly a documentation-lookup tool, though it never names how it differs from search_knowledge_base, which could plausibly surface similar content.

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

Usage Guidelines2/5

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

The description gives no conditions for use and names no alternatives. An agent is left to infer that this is the tool for endpoint-level spec details rather than the generic knowledge-base search or the sample-payload generator; nothing states when this tool is preferred over those siblings.

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