Skip to main content
Glama

publish_pages

Destructive

Publishes many pages/endpoints at once: each page in pageIds gets a new default published version and state 2 (approved/published). rootParentId (the collection's invisible root page) must also be supplied so it is marked published. Requires READ_WRITE permission. Triggers background search indexing, translation and AI SEO/meta generation, and clears the docs cache. Get ids from List Collections (rootParentId) and List Collection Pages. Body fields:

rootParentId (string, required) - 12-char id of the collection's invisible root page (type 0). pageIds (array<string>, required) - Non-empty array of 12-char page/endpoint ids to publish. PATCH https://api.docstar.io/orgs/:orgId/collections/:collectionId/bulkPublish

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "orgId": "<orgId>",
      "collectionId": "<collectionId>"
    },
    "name": "publish_pages"
  }
}

Input Schema

NameRequiredDescriptionDefault
orgIdYesThe orgId path variable
pageIdsNoe.g. ["Pg12Ab34Cd56","Pg98Zy76Xw54"]
collectionIdYesThe collectionId path variable
rootParentIdNoe.g. Xy12Ab34Cd56

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

The description provides rich behavioral context beyond the annotations and schema. It details high-impact side effects (Triggers background search indexing, translation and AI SEO/meta generation, and clears the docs cache) and specifies the required permission level (READ_WRITE).

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?

While slightly verbose due to the high complexity of the tool, the structure is excellent. It front-loads the primary action, follows with mandatory constraints, then operational side effects and prerequisites.

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

Completeness5/5

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

Given that this is a complex, high-impact mutation tool, the definition is exceptionally complete. It covers the action, the required inputs, the necessary permissions, and the consequential side effects of the operation. No major operational gap exists for an AI agent.

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?

Although the schema coverage is 100%, the description adds vital semantic context. It explains that `rootParentId` is 'the collection's invisible root page (type 0)' and defines `pageIds` as non-empty arrays of 12-character IDs, adding functional meaning that the schema alone lacks.

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 clearly states the purpose: to 'Publishes many pages/endpoints at once,' which specifies the resource (pages/endpoints) and the action (bulk publishing). It is clearly differentiated from single-update or creation tools listed as siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It specifies the use case is for bulk publication. Furthermore, it provides crucial workflow guidance by directing the user where to obtain the necessary IDs: 'Get ids from List Collections (rootParentId) and List Collection Pages.' This helps the agent understand the pre-conditions for calling the tool.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources