Skip to main content
Glama

get_edition_description_sections

Read-onlyIdempotent

Retrieve all edition description sections with optional pagination using cursor and per_page parameters.

Instructions

Get all edition description section records

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
cursorNoCursor for fetching the next page of results
per_pageNoNumber of results per page (default: 25)

Implementation Reference

  • The handler function for the get_edition_description_sections tool. Calls the API to list edition description sections and formats the result.
    async ({ cursor, per_page }) => {
      try {
        const result = await apiList<EduframeRecord>("/edition_description_sections", { cursor, per_page });
        void logResponse("get_edition_description_sections", { cursor, per_page }, result);
        const toolResult = formatList(result.records, "edition description sections");
        if (result.nextCursor) {
          toolResult.content.push({ type: "text", text: `\nNext page cursor: ${result.nextCursor}` });
        }
        return toolResult;
      } catch (error) {
        return formatError(error);
      }
    },
  • Input schema defining optional 'cursor' (string) and 'per_page' (positive integer) parameters for pagination.
    {
      description: "Get all edition description section records",
      annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
      inputSchema: {
        cursor: z.string().optional().describe("Cursor for fetching the next page of results"),
        per_page: z.number().int().positive().optional().describe("Number of results per page (default: 25)"),
      },
  • Registration function registerEditionDescriptionSectionTools that registers the tool on the MCP server with its schema and handler.
    export function registerEditionDescriptionSectionTools(server: McpServer): void {
      server.registerTool(
        "get_edition_description_sections",
        {
          description: "Get all edition description section records",
          annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
          inputSchema: {
            cursor: z.string().optional().describe("Cursor for fetching the next page of results"),
            per_page: z.number().int().positive().optional().describe("Number of results per page (default: 25)"),
          },
        },
        async ({ cursor, per_page }) => {
          try {
            const result = await apiList<EduframeRecord>("/edition_description_sections", { cursor, per_page });
            void logResponse("get_edition_description_sections", { cursor, per_page }, result);
            const toolResult = formatList(result.records, "edition description sections");
            if (result.nextCursor) {
              toolResult.content.push({ type: "text", text: `\nNext page cursor: ${result.nextCursor}` });
            }
            return toolResult;
          } catch (error) {
            return formatError(error);
          }
        },
      );
    }
  • Import of registerEditionDescriptionSectionTools in the central tools index.
    import { registerEditionDescriptionSectionTools } from "./edition_description_sections";
  • Registration of registerEditionDescriptionSectionTools in the tools array called by registerAllTools.
    registerEditionDescriptionSectionTools,
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, covering safety and idempotency. The description adds no behavioral details beyond 'get all', missing pagination behavior or timeouts. It does not contradict annotations.

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?

A single sentence with no extra fluff, but the word 'all' is imprecise. Structure is fine; front-loading is not an issue.

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?

No output schema exists, so the description should hint at what a record contains or how pagination works. It only says 'all', which is misleading. The tool is a listing operation with pagination, but this is not explained.

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 coverage is 100%, so the parameters are fully documented in the input schema. The description adds no additional meaning about cursor or per_page, meeting the baseline but not exceeding it.

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 verb 'Get' clearly indicates retrieval, and 'edition description section records' specifies the resource. However, the word 'all' conflicts with the pagination implied by the input schema (cursor, per_page), causing slight ambiguity. The tool is distinct among siblings but not differentiated.

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?

The description provides no guidance on when to use this tool versus other listing tools (e.g., get_program_edition, get_elements_of_program_edition). No context about prerequisites or alternatives is given.

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/martijnpieters/eduframe-mcp'

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