Skip to main content
Glama

edit_group_wiki_page

Update and manage GitLab group wiki pages by modifying content, title, format, and slug. Supports markdown, rdoc, asciidoc, and org formats for enhanced collaboration.

Instructions

Edit an existing wiki page for a GitLab group

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
contentNo
formatNo
group_idNo
slugNo
titleNo

Implementation Reference

  • Core handler function in GitLabApi class that executes the PUT request to the GitLab API endpoint for editing a group wiki page.
    async editGroupWikiPage(
      groupId: string,
      slug: string,
      options: {
        title?: string;
        content?: string;
        format?: WikiPageFormat;
      }
    ): Promise<GitLabWikiPage> {
      const response = await fetch(
        `${this.apiUrl}/groups/${encodeURIComponent(groupId)}/wikis/${encodeURIComponent(slug)}`,
        {
          method: "PUT",
          headers: {
            Authorization: `Bearer ${this.token}`,
            "Content-Type": "application/json",
          },
          body: JSON.stringify({
            title: options.title,
            content: options.content,
            format: options.format,
          }),
        }
      );
    
      if (!response.ok) {
        throw new McpError(
          ErrorCode.InternalError,
          `GitLab API error: ${response.statusText}`
        );
      }
    
      // Parse the response JSON
      const wikiPage = await response.json();
    
      // Validate and return the response
      return GitLabWikiPageSchema.parse(wikiPage);
    }
  • Zod schema defining the input validation for the tool: requires group_id and slug, optional title, content, and format.
    export const EditGroupWikiPageSchema = z.object({
      group_id: z.string(),
      slug: z.string(),
      title: z.string().optional(),
      content: z.string().optional(),
      format: WikiPageFormatEnum.optional()
    });
  • src/index.ts:249-252 (registration)
    Tool registration in ALL_TOOLS array, defining name, description, input schema, and read-only status for listTools.
    name: "edit_group_wiki_page",
    description: "Edit an existing wiki page for a GitLab group",
    inputSchema: createJsonSchema(EditGroupWikiPageSchema),
    readOnly: false
  • Dispatch handler in the main CallToolRequest switch statement that parses args and calls the GitLabApi.editGroupWikiPage method.
    case "edit_group_wiki_page": {
      const args = EditGroupWikiPageSchema.parse(request.params.arguments);
      const wikiPage = await gitlabApi.editGroupWikiPage(args.group_id, args.slug, {
        title: args.title,
        content: args.content,
        format: args.format
      });
      return formatWikiPageResponse(wikiPage);
    }
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states 'Edit an existing wiki page', implying a mutation operation, but fails to mention critical aspects like required permissions, whether edits are reversible, or potential side effects (e.g., version history). This leaves significant gaps in understanding the tool's behavior.

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 a single, straightforward sentence with no unnecessary words, making it highly concise and front-loaded. It efficiently communicates the core action without waste.

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 of a mutation tool with 5 parameters, no annotations, and no output schema, the description is insufficient. It lacks details on parameters, behavioral traits, usage context, and expected outcomes, making it incomplete for effective tool selection and invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 5 parameters with 0% description coverage, and the tool description provides no information about any parameters. It does not explain what 'group_id', 'slug', 'content', 'title', or 'format' mean or how they should be used, failing to compensate for the lack of schema documentation.

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?

The description clearly states the action ('Edit') and resource ('an existing wiki page for a GitLab group'), making the purpose understandable. However, it does not differentiate from its sibling 'edit_project_wiki_page', which is similar but for projects instead of groups, leaving some ambiguity in sibling context.

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 on when to use this tool versus alternatives like 'edit_project_wiki_page' or 'create_group_wiki_page'. The description lacks context on prerequisites, such as needing an existing page or group permissions, leaving usage unclear.

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

Related 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/yoda-digital/mcp-gitlab-server'

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