Skip to main content
Glama
hackle-io

hackle-mcp

Official
by hackle-io

push-message-list

Retrieve paginated push message lists with search functionality to filter by name, description, or campaign key. Simplifies fetching and managing A/B test data in Hackle MCP.

Instructions

Fetches a paginated list of push messages with search functionality.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNumberNo
pageSizeNo
searchKeywordNoname, description, or campaignKey of a push message.

Implementation Reference

  • Handler function that builds a query string from input parameters and fetches the paginated list of push messages via WebClient.get API call, returning JSON stringified response as text content.
    async ({ pageNumber = 1, pageSize = 100, searchKeyword = '' }) => {
      const qs = stringify(
        {
          pageNumber,
          pageSize,
          searchKeyword,
        },
        { addQueryPrefix: true },
      );
    
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(await WebClient.get(`/api/v1/push-messages${qs}`)),
          },
        ],
      };
    },
  • Input schema using Zod for validating optional parameters: pageNumber (default 1), pageSize (default 100), and searchKeyword.
    {
      pageNumber: z.number().optional().default(1),
      pageSize: z.number().optional().default(100),
      searchKeyword: z.string().optional().describe('name, description, or campaignKey of a push message.'),
    },
  • src/index.ts:113-140 (registration)
    Registration of the 'push-message-list' tool using server.tool, including description, input schema, and inline handler function.
    server.tool(
      'push-message-list',
      'Fetches a paginated list of push messages with search functionality.',
      {
        pageNumber: z.number().optional().default(1),
        pageSize: z.number().optional().default(100),
        searchKeyword: z.string().optional().describe('name, description, or campaignKey of a push message.'),
      },
      async ({ pageNumber = 1, pageSize = 100, searchKeyword = '' }) => {
        const qs = stringify(
          {
            pageNumber,
            pageSize,
            searchKeyword,
          },
          { addQueryPrefix: true },
        );
    
        return {
          content: [
            {
              type: 'text',
              text: JSON.stringify(await WebClient.get(`/api/v1/push-messages${qs}`)),
            },
          ],
        };
      },
    );
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It mentions pagination and search, but lacks details on permissions, rate limits, error handling, or response format. For a read operation with no annotation coverage, this is insufficient to inform safe and effective use.

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 that front-loads the core purpose. Every word earns its place, with no redundancy or unnecessary elaboration, making it easy to parse quickly.

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 tool's complexity (3 parameters, no output schema, no annotations), the description is incomplete. It doesn't cover behavioral aspects like pagination mechanics, search limitations, or return values, leaving gaps that could hinder correct tool selection and invocation.

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 low (33%), with only 'searchKeyword' documented. The description adds value by clarifying that search applies to 'name, description, or campaignKey', but doesn't explain 'pageNumber' or 'pageSize' beyond defaults. It partially compensates for the coverage gap but leaves key parameters under-specified.

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 ('fetches') and resource ('paginated list of push messages'), and specifies the functionality ('with search functionality'). It distinguishes from siblings like 'push-message-detail' by indicating it's a list operation, though it doesn't explicitly contrast with other list tools (e.g., 'in-app-message-list').

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 alternatives. It doesn't mention when to choose it over 'push-message-detail' for individual messages or other list tools, nor does it specify prerequisites or exclusions. Usage is implied only by the tool name and description.

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/hackle-io/hackle-mcp'

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