Skip to main content
Glama

telegraph_get_page_list

Retrieve a list of pages from a Telegraph account using an access token, with options to specify offset and limit for paginated results.

Instructions

Get a list of pages belonging to a Telegraph account. Returns a PageList object with total_count and pages array.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
access_tokenYesAccess token of the Telegraph account
offsetNoSequential number of the first page to be returned (default: 0)
limitNoNumber of pages to be returned (0-200, default: 50)

Implementation Reference

  • Handler case in handlePageTool that validates input using GetPageListSchema and delegates to telegraph.getPageList, returning JSON stringified result
    case 'telegraph_get_page_list': {
      const input = GetPageListSchema.parse(args);
      const result = await telegraph.getPageList(
        input.access_token,
        input.offset,
        input.limit
      );
      return {
        content: [{
          type: 'text' as const,
          text: JSON.stringify(result, null, 2),
        }],
      };
    }
  • Zod input schema for validating tool parameters
    export const GetPageListSchema = z.object({
      access_token: z.string().describe('Access token of the Telegraph account'),
      offset: z.number().int().min(0).optional().describe('Sequential number of the first page (default: 0)'),
      limit: z.number().int().min(0).max(200).optional().describe('Number of pages to return (0-200, default: 50)'),
    });
  • Tool registration definition in pageTools array including name, description, and JSON inputSchema
    {
      name: 'telegraph_get_page_list',
      description: 'Get a list of pages belonging to a Telegraph account. Returns a PageList object with total_count and pages array.',
      inputSchema: {
        type: 'object' as const,
        properties: {
          access_token: {
            type: 'string',
            description: 'Access token of the Telegraph account',
          },
          offset: {
            type: 'integer',
            description: 'Sequential number of the first page to be returned (default: 0)',
            minimum: 0,
            default: 0,
          },
          limit: {
            type: 'integer',
            description: 'Number of pages to be returned (0-200, default: 50)',
            minimum: 0,
            maximum: 200,
            default: 50,
          },
        },
        required: ['access_token'],
      },
    },
  • Supporting function that performs the actual Telegraph API call to retrieve page list using apiRequest
    export async function getPageList(
      access_token: string,
      offset?: number,
      limit?: number
    ): Promise<PageList> {
      return apiRequest<PageList>('getPageList', {
        access_token,
        offset,
        limit,
      });
    }
Behavior3/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 adds useful context about the return format ('PageList object with total_count and pages array'), which helps understand output structure. However, it doesn't mention authentication requirements (implied by access_token but not stated), rate limits, or pagination behavior beyond offset/limit parameters, leaving gaps for a read operation.

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 perfectly concise with two sentences: one stating the purpose and one explaining the return value. Every word earns its place, and it's front-loaded with the core functionality. No wasted text or redundancy.

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

Completeness4/5

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

For a read-only list tool with 100% schema coverage but no output schema, the description is reasonably complete. It covers the purpose and return structure, though it could benefit from more behavioral context (e.g., authentication notes, error cases). Given the tool's moderate complexity and lack of annotations, it's mostly adequate but has minor gaps.

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 the schema fully documents all three parameters (access_token, offset, limit). The description adds no additional parameter semantics beyond what's in the schema, such as explaining how offset/limit interact or clarifying token usage. Baseline 3 is appropriate when the schema does all the heavy lifting.

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 specific action ('Get a list of pages') and resource ('belonging to a Telegraph account'), distinguishing it from siblings like telegraph_get_page (single page) and telegraph_get_account_info (account metadata). It precisely identifies what the tool does without being vague or tautological.

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

Usage Guidelines3/5

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

The description implies usage for retrieving multiple pages from an account, but provides no explicit guidance on when to use this versus alternatives like telegraph_get_page (for single pages) or telegraph_backup_account (for backups). It lacks explicit when/when-not statements or named alternatives, leaving usage context implied rather than clearly defined.

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/NehoraiHadad/telegraph-mcp'

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