Skip to main content
Glama

update_page

Modify existing wiki pages by updating content, metadata, or structure within BookStack. Change page text, tags, location, or priority to maintain current documentation.

Instructions

Update an existing page

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesPage ID
book_idNoMove to different book ID
chapter_idNoMove to different chapter ID
nameNoPage name (max 255 chars)
htmlNoPage content in HTML format
markdownNoPage content in Markdown format
tagsNoArray of tags with name and value
priorityNoPage priority/order

Implementation Reference

  • Handler logic in handleContentTool that destructures args, parses and validates input using UpdatePageSchema, converts tags, calls client.updatePage, and returns formatted response.
    case "update_page": {
      const { id, ...updateData } = args;
      const pageId = parseInteger(id);
      const validatedData = UpdatePageSchema.parse(updateData);
      const data = {
        ...validatedData,
        tags: convertTags(validatedData.tags),
      };
      const result = await client.updatePage(pageId, data);
      return formatApiResponse(result);
    }
  • Zod validation schema for update_page tool parameters, used in the handler for input validation.
    export const UpdatePageSchema = z.object({
      book_id: z.number().optional(),
      chapter_id: z.number().optional(),
      name: z.string().min(1).max(255).optional(),
      html: z.string().optional(),
      markdown: z.string().optional(),
      tags: z.array(TagSchema).optional(),
      priority: z.number().optional(),
    });
  • Tool definition registered in createContentTools function, including name, description, and input schema matching UpdatePageSchema.
    {
      name: "update_page",
      description: "Update an existing page",
      inputSchema: {
        type: "object",
        properties: {
          id: { type: "number", description: "Page ID" },
          book_id: { type: "number", description: "Move to different book ID" },
          chapter_id: {
            type: "number",
            description: "Move to different chapter ID",
          },
          name: { type: "string", description: "Page name (max 255 chars)" },
          html: { type: "string", description: "Page content in HTML format" },
          markdown: {
            type: "string",
            description: "Page content in Markdown format",
          },
          tags: {
            type: "array",
            description: "Array of tags with name and value",
            items: {
              type: "object",
              properties: {
                name: { type: "string" },
                value: { type: "string" },
                order: { type: "number" },
              },
              required: ["name", "value"],
            },
          },
          priority: { type: "number", description: "Page priority/order" },
        },
        required: ["id"],
      },
  • src/index.ts:124-126 (registration)
    Dispatch logic in MCP server request handler that routes 'update_page' (listed in contentToolNames) to handleContentTool.
    if (contentToolNames.includes(name)) {
      result = await handleContentTool(name, args, bookStackClient);
    } else if (searchUserToolNames.includes(name)) {
  • BookStackClient.updatePage method called by the handler, performs the actual PUT API request to update the page.
    async updatePage(
      id: number,
      data: Partial<CreatePageRequest>
    ): Promise<Page> {
      return this.put<Page>(`/pages/${id}`, data);
    }
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. 'Update an existing page' implies a mutation operation but doesn't disclose permission requirements, whether changes are reversible, rate limits, or what happens to unspecified fields. It mentions no side effects or response format, leaving significant behavioral gaps.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise - a single three-word phrase that's front-loaded with the essential action. There's zero wasted verbiage, though this conciseness comes at the cost of completeness.

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?

For a mutation tool with 8 parameters, no annotations, and no output schema, the description is insufficiently complete. It doesn't explain what 'update' entails (partial vs full updates), doesn't mention the required ID parameter, and provides no context about the update operation's behavior or results.

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 description coverage is 100%, so all parameters are documented in the schema. The description adds no additional parameter information beyond what's in the schema. According to scoring rules, when schema coverage is high (>80%), the baseline is 3 even with no param info in the description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Update an existing page' clearly states the action (update) and resource (page), but it's generic and doesn't distinguish this from other update tools like update_book or update_chapter. It specifies the target is 'existing' which helps differentiate from create_page, but lacks specificity about what aspects can be updated.

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 about when to use this tool versus alternatives. The description doesn't mention prerequisites (like needing the page ID), when not to use it, or how it differs from other update tools. The agent must infer usage from the parameter schema 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/lautarobarba/bookstack_mcp_server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server