Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

Swagger: Search APIs and Domains

swagger_search_apis_and_domains
Read-onlyIdempotent

Search for APIs and domains in SwaggerHub Registry using filters like query, state, tag, owner, and spec type. Retrieve metadata including version and specification.

Instructions

Search for APIs and Domains in SwaggerHub Registry using the comprehensive /specs endpoint and retrieve metadata including owner, name, description, summary, version, and specification.

Toolset: Registry API

Parameters:

  • query (string): Search query to filter APIs by name, description, or content

  • state (enum): Filter APIs by publication state - ALL (default), PUBLISHED, or UNPUBLISHED

  • tag (string): Filter APIs by tag

  • offset (number): Offset for pagination (0-based, default 0)

  • limit (number): Number of results per page (1-100, default 20)

  • sort (enum): Sort field - NAME, UPDATED, or CREATED (default NAME)

  • order (enum): Sort order - ASC or DESC (default ASC)

  • owner (string): Filter APIs by owner (organization or user)

  • specType (enum): Filter by specification type - API or DOMAIN (default all types)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tagNoFilter APIs by tag
sortNoSort field - NAME, UPDATED, or CREATED (default NAME)
limitNoNumber of results per page (1-100, default 20)
orderNoSort order - ASC or DESC (default ASC)
ownerNoFilter APIs by owner (organization or user)
queryNoSearch query to filter APIs by name, description, or content
stateNoFilter APIs by publication state - ALL (default), PUBLISHED, or UNPUBLISHED
offsetNoOffset for pagination (0-based, default 0)
specTypeNoFilter by specification type - API or DOMAIN (default all types)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
itemsYes
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the description does not need to reiterate safety. It adds the endpoint information and parameter defaults, but does not disclose any additional behavioral traits like pagination limits or return format beyond what schema provides.

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?

The description is concise: one sentence for purpose, a toolset label, and a parameter list. No extraneous text. It is well-structured and front-loaded with key information.

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?

Given the complexity (9 parameters, output schema exists), the description covers the main purpose and parameter details. It does not explain return values, but output schema is available. Missing explicit mention of pagination behavior, but offset and limit are listed. Adequately complete for a search 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 coverage is 100% with detailed descriptions for all 9 parameters. The description repeats the parameter list with enum values and defaults, adding minimal new meaning. For high schema coverage, baseline 3 is appropriate.

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?

The description clearly states the verb ('Search'), the resource ('APIs and Domains in SwaggerHub Registry'), and the endpoint ('/specs'). It distinguishes this tool from sibling tools like swagger_get_api_definition or swagger_create_api_from_prompt by focusing on search and listing.

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?

No guidance on when to use this tool versus alternatives. It does not explain when search is preferred over other SwaggerHub tools, nor does it mention prerequisites or context for usage.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/SmartBear/smartbear-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server