Skip to main content
Glama

get_image

Retrieve specific image details from BookStack wiki by providing its ID for content management and reference.

Instructions

Get details of a specific image

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesImage ID

Implementation Reference

  • Handler logic for the 'get_image' MCP tool. Parses the input 'id', calls the BookStack client's getImage method, and returns a formatted API response.
    case "get_image": {
      const id = parseInteger(args.id);
      const result = await client.getImage(id);
      return formatApiResponse(result);
    }
  • Tool definition including name, description, and input schema (requires 'id' as number) for the 'get_image' tool, returned by createSearchAndUserTools.
    {
      name: "get_image",
      description: "Get details of a specific image",
      inputSchema: {
        type: "object",
        properties: {
          id: { type: "number", description: "Image ID" },
        },
        required: ["id"],
      },
    },
  • Core implementation in BookStackClient that makes the HTTP GET request to /api/image-gallery/{id} to fetch image details.
    async getImage(id: number): Promise<ImageGallery> {
      const response: AxiosResponse<ImageGallery> = await this.api.get(
        `/image-gallery/${id}`
      );
      return response.data;
    }
  • src/index.ts:103-122 (registration)
    Registration of 'get_image' in the searchUserToolNames array, which determines dispatch to handleSearchAndUserTool in the MCP server's CallToolRequest handler.
    const searchUserToolNames = [
      "search_all",
      "list_users",
      "get_user",
      "create_user",
      "update_user",
      "delete_user",
      "list_roles",
      "get_role",
      "create_role",
      "update_role",
      "delete_role",
      "list_attachments",
      "get_attachment",
      "delete_attachment",
      "list_images",
      "get_image",
      "update_image",
      "delete_image",
    ];
  • src/index.ts:56-59 (registration)
    Includes tools from createSearchAndUserTools (containing 'get_image' definition) into the allTools list returned by ListToolsRequest to the MCP server.
    const allTools: Tool[] = [
      ...createContentTools(bookStackClient),
      ...createSearchAndUserTools(bookStackClient),
    ];
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 'Get details' but doesn't specify what details are returned, if authentication is required, or any rate limits. This leaves significant gaps for a tool that likely fetches data.

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, efficient sentence with zero waste, clearly front-loaded with the core action. It earns its place by succinctly conveying the tool's 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 lack of annotations and output schema, the description is incomplete. It doesn't explain what details are returned, error conditions, or behavioral traits, making it inadequate for a tool that likely involves data retrieval without structured output documentation.

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?

The input schema has 100% description coverage, with the 'id' parameter documented as 'Image ID'. The description adds no additional meaning beyond this, such as format examples or constraints, so it meets the baseline for high schema coverage.

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 verb ('Get details') and resource ('of a specific image'), making the purpose understandable. However, it doesn't differentiate from sibling tools like 'list_images' or 'update_image' beyond the basic action, missing explicit scope comparison.

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 such as 'list_images' for multiple images or 'update_image' for modifications. The description implies usage for a single image but lacks explicit context or exclusions.

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