Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear
OverviewSchemaRelated ServersScoreDiscussions
TypeScript
Hybrid

Swagger: Create Portal

swagger_create_portal
Read-onlyIdempotent

Create a new API portal in Swagger by specifying a subdomain and organization ID, with options for offline mode, routing, credentials, and rendering style.

Instructions

Create a new portal within Swagger.

Toolset: Portals

Parameters:

  • name (string): The display name for the portal - shown to users and in branding (3-40 characters)

  • subdomain (string) required: The portal subdomain - used in the portal URL (e.g., 'myportal' for myportal.example.com). Must be unique, lowercase, 3-20 characters, alphanumeric with hyphens

  • offline (boolean): If true, the portal will not be visible to customers - useful for development/staging environments. Defaults to false

  • routing (string): Routing strategy for the portal - either 'browser' (client-side routing) or 'proxy' (server-side routing). Defaults to 'browser'

  • credentialsEnabled (boolean): Whether authentication credentials are enabled for accessing the portal. When true, users can authenticate to access private content. Defaults to true

  • swaggerHubOrganizationId (string) required: The corresponding Swagger organization UUID - required for portal creation. This links the portal to your Swagger organization. Only one Portal per Swagger organization is allowed.

  • openapiRenderer (string): OpenAPI renderer type: 'SWAGGER_UI' (Swagger UI), 'ELEMENTS' (Stoplight Elements), or 'TOGGLE' (allows switching between both with Elements as default). Defaults to 'TOGGLE'

  • pageContentFormat (string): Format for page content rendering - determines how documentation pages are processed: 'HTML', 'MARKDOWN', or 'BOTH'. Defaults to 'HTML'

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoThe display name for the portal - shown to users and in branding (3-40 characters)
offlineNoIf true, the portal will not be visible to customers - useful for development/staging environments. Defaults to false
routingNoRouting strategy for the portal - either 'browser' (client-side routing) or 'proxy' (server-side routing). Defaults to 'browser'
subdomainYesThe portal subdomain - used in the portal URL (e.g., 'myportal' for myportal.example.com). Must be unique, lowercase, 3-20 characters, alphanumeric with hyphens
openapiRendererNoOpenAPI renderer type: 'SWAGGER_UI' (Swagger UI), 'ELEMENTS' (Stoplight Elements), or 'TOGGLE' (allows switching between both with Elements as default). Defaults to 'TOGGLE'
pageContentFormatNoFormat for page content rendering - determines how documentation pages are processed: 'HTML', 'MARKDOWN', or 'BOTH'. Defaults to 'HTML'
credentialsEnabledNoWhether authentication credentials are enabled for accessing the portal. When true, users can authenticate to access private content. Defaults to true
swaggerHubOrganizationIdYesThe corresponding Swagger organization UUID - required for portal creation. This links the portal to your Swagger organization. Only one Portal per Swagger organization is allowed.

Tool Definition Quality

C2.7/5.0
Behavior1/5

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

Annotations declare readOnlyHint=true, which directly contradicts the description stating it creates a portal (a write operation). This is a critical inconsistency. The description does not address this or other behavioral aspects like idempotency implications.

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 description is reasonably structured with a clear purpose and bulleted parameters, but it largely duplicates the input schema descriptions. The length could be trimmed without losing essential information.

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

Completeness2/5

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

Despite having 8 parameters and no output schema, the description fails to mention the return value or success response. The contradiction with annotations undermines completeness. For a creation tool, more context about the result and possible errors is needed.

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 baseline is 3. The description adds useful context beyond the schema, such as noting that only one portal per organization is allowed and explaining defaults. However, the additional value is moderate.

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 clearly states 'Create a new portal within Swagger' with a specific verb and resource. However, it does not differentiate from sibling tools like 'swagger_create_portal_product' or 'swagger_create_api_from_prompt', lacking explicit distinction.

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 is provided on when to use this tool versus alternatives like 'swagger_update_portal' or 'swagger_create_portal_product'. There is no mention of prerequisites (e.g., existing organization) or when not to use it.

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