Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

Swagger: Create Table Of Contents

swagger_create_table_of_contents
Idempotent

Creates a table of contents item for portal sections, supporting API references, HTML, or Markdown content with customizable ordering and nesting.

Instructions

Create a new table of contents item in a portal product section. Supports API references, HTML content, and Markdown content types.

Toolset: Table Of Contents

Parameters:

  • sectionId (string) required: Section ID - unique identifier for the section within the product

  • type (enum) required: Type of table of contents creation - 'new' to create from scratch or 'copy' to duplicate an existing one

  • title (string) required: Title of the table of contents item - will be displayed in navigation (3-40 characters)

  • slug (string) required: URL-friendly identifier for the table of contents item - must be unique within the section (3-22 characters, lowercase, alphanumeric with hyphens/underscores/dots)

  • order (number) required: Order position of the table of contents item within its parent section or item

  • parentId (string): Parent table of contents item ID - null for top-level items, or ID of parent item for nested structure

  • content (object): Content configuration for the table of contents item

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesURL-friendly identifier for the table of contents item - must be unique within the section (3-22 characters, lowercase, alphanumeric with hyphens/underscores/dots)
typeYesType of table of contents creation - 'new' to create from scratch or 'copy' to duplicate an existing one
orderYesOrder position of the table of contents item within its parent section or item
titleYesTitle of the table of contents item - will be displayed in navigation (3-40 characters)
contentNoContent configuration for the table of contents item
parentIdNoParent table of contents item ID - null for top-level items, or ID of parent item for nested structure
sectionIdYesSection ID - unique identifier for the section within the product

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo
documentIdNo
Behavior3/5

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

Annotations already indicate readOnlyHint=false, destructiveHint=false, and idempotentHint=true. The description adds little beyond the content type support. It does not disclose potential behavioral traits like idempotency implications, required permissions, or what happens on duplicate creation. The description does not contradict annotations.

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 reasonably concise, with four sentences and a parameter list. However, the parameter list is redundant with the input schema. The structure is clear and front-loaded with the purpose.

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 (7 parameters, nested content object, enum types) and the presence of an output schema, the description covers the core functionality and content types adequately. It does not explain the output, but that is acceptable since an output schema exists.

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%, so baseline is 3. The description repeats some parameter details already in the schema (e.g., slug constraints, content type options) but does not add new meaningful semantics beyond what the schema provides.

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 states 'Create a new table of contents item in a portal product section' with specific verb and resource, and mentions supported content types (API references, HTML, Markdown). This clearly distinguishes it from sibling tools like swagger_delete_table_of_contents or swagger_list_table_of_contents.

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 explicit guidance on when to use this tool versus alternatives. The description does not mention prerequisites, when not to use it, or compare with other table of contents operations. Sibling tools include create, delete, list, and get, but no differentiation is provided.

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