Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear
OverviewSchemaRelated ServersScoreDiscussions
TypeScript
Hybrid

Swagger: Create Portal

swagger_create_portal
Idempotent

Create a new Swagger portal for hosting API documentation. Requires a unique subdomain and organization UUID to generate a customizable, public or offline portal.

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.

Output Schema

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

Tool Definition Quality

A3.6/5.0
Behavior3/5

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

Annotations already indicate this is a mutation (readOnlyHint false) and non-destructive (destructiveHint false). The description adds the subdomain uniqueness and one-portal-per-org constraint but does not disclose auth requirements, rate limits, or error behaviors beyond that.

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 structured with a 'Toolset' header and a parameter list, but it is verbose, essentially repeating schema descriptions. It could be more front-loaded with the core purpose and constraints.

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 8 parameters and an existing output schema, the description covers all parameter details and critical constraints like subdomain uniqueness and one-portal-per-org. It missing explicit return value info, but the output schema likely compensates for that.

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 description adds narrative context (e.g., 'shown to users and in branding' for name, 'useful for development/staging environments' for offline). This adds meaningful information beyond the schema descriptions.

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 explicitly states 'Create a new portal within Swagger,' providing a clear verb and resource. It distinguishes itself from sibling tools like swagger_update_portal through the 'create' verb and the unique subdomain constraint.

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 given on when to use this tool versus alternatives like updating an existing portal. It does not include when-not-to-use or prerequisite conditions, leaving the agent to infer context from the tool name alone.

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