Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

Swagger: Get Portal

swagger_get_portal
Read-onlyIdempotent

Retrieves portal details using the portal's UUID or subdomain, enabling access to Swagger portal information for API testing and analysis.

Instructions

Retrieve information about a specific portal.

Toolset: Portals

Parameters:

  • portalId (string) required: Portal UUID or subdomain - unique identifier for the portal instance

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
portalIdYesPortal UUID or subdomain - unique identifier for the portal instance

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo
nameNo
offlineNo
routingNo
subdomainNo
customDomainNo
openapiRendererNo
credentialsEnabledNo
swaggerHubOrganizationIdNo
Install Server

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already provide readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is clear. The description's read-only language aligns with the annotations but adds no further behavioral context such as error cases, authentication requirements, or response characteristics beyond what the output schema already covers.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The opening sentence is concise and front-loaded. However, the 'Toolset: Portals' line and the parameter bullet add little value because the input schema already documents the parameter and the toolset is inferable from the tool name and siblings.

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?

This is a simple one-parameter, read-only getter with rich annotations and an output schema, so the description is largely complete. The main gap is not telling callers to use swagger_list_portals when they need to discover the portalId first.

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%, and the parameter listed in the description ('Portal UUID or subdomain - unique identifier for the portal instance') repeats the schema's own description verbatim. It adds no extra semantic detail like examples, format expectations, or guidance on choosing between UUID vs subdomain.

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?

The description states a clear verb and resource: 'Retrieve information about a specific portal.' The word 'specific' distinguishes this from swagger_list_portals, but it does not explicitly name sibling alternatives or explain how it differs from swagger_resolve_organization_portal.

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 implied: call this when you have a portal UUID or subdomain and need that portal's information. However, there is no explicit when-to-use guidance, no mention of alternatives like swagger_list_portals for discovering portal IDs, and no exclusions or prerequisites.

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

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