Skip to main content
Glama

viaSocket

get_viasocket_api_docs

Read-onlyIdempotent

Browse the viaSocket API docs, one level at a time. Call it without arguments to get the top level: the modules and pages with a short description and the endpoints they hold. Call it with path set to a module's or page's link (or path) to get what is inside it; each listing links the next level. Call it with path set to an endpoint's link ending in ".openapi.yml" to get that endpoint as an OpenAPI file: method, url, headers, query params, path variables, a request body example and sample responses. Fetch only the level you need.

Input Schema

NameRequiredDescriptionDefault
pathNoA link from a listing, exactly as given (e.g. "https://docs.example.com/sms/llms.txt" or ".../sms/send-sms.openapi.yml"), or just the path ("sms", "sms/send-sms.openapi.yml"). Leave it out for the top level.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already cover safety (readOnly, idempotent, non-destructive) so that burden is lifted, and the description still invests heavily in describing what each call returns: module/page listings with short descriptions and held endpoints, and a full OpenAPI payload with method, url, headers, query params, path variables, body example and sample responses. With no output schema present, this return-shape disclosure is exactly the added value needed.

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?

Four short sentences, front-loaded with the traversal model and then each invocation mode in sequence. No filler; the final sentence ('Fetch only the level you need') is a genuine efficiency instruction rather than padding.

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

Completeness5/5

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

A single optional parameter, no output schema, and rich annotations, yet the description still covers all three request modes and the corresponding return contents. Nothing an agent needs to call this correctly is missing.

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% and the schema already explains the accepted forms, so the baseline is 3. The description earns above baseline by tying the parameter to the three distinct behaviors (omit = top level, module/page link = listing, '.openapi.yml' = endpoint spec), which is routing meaning rather than restatement.

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 ('Browse') and resource ('viaSocket API docs') plus the traversal model ('one level at a time'), which is exactly the property that separates it from a flat search tool. An agent can predict the response shape at each level without opening any schema.

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

Usage Guidelines4/5

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

Gives explicit invocation modes: no arguments for the top level, `path` for a module/page, `path` ending in '.openapi.yml' for an endpoint spec. It also advises 'Fetch only the level you need.' It stops short of naming siblings such as search_viasocket_docs or saying when NOT to browse (e.g., when you already know what you want and should search instead).

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