Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

Swagger: Create Table Of Contents

swagger_create_table_of_contents
Read-onlyIdempotent

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

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
Behavior1/5

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

The description states 'create' (a mutation), but annotations include readOnlyHint=true, which is a direct contradiction. The tool does not disclose essential behavioral traits such as authorization requirements, idempotency implications, or what happens to existing data.

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 includes a redundant parameter listing that largely duplicates the schema, making it longer than necessary. However, it is still structured and front-loaded with the primary purpose.

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?

Given the complexity (7 parameters, nested objects, no output schema), the description does not explain return values, error handling, or behavior beyond creation. The annotation contradiction further undermines completeness.

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?

Input schema has 100% description coverage, so the tool description's parameter list adds minimal new meaning beyond what is already in the schema. No extra context or clarifications are provided.

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?

Clearly states the tool creates a table of contents item in a portal product section and lists supported content types. The verb and resource are specific, but it does not explicitly differentiate from sibling tools like swagger_update_document or swagger_delete_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. It mentions supported content types but does not provide context for when to use each or exclude other tools like swagger_create_documentation_page.

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