Skip to main content
Glama
hackle-io

hackle-mcp

Official
by hackle-io

in-app-message-detail

Retrieve detailed information on specific in-app messages using the tool integrated with Hackle’s MCP server, enabling precise querying of A/B test message data.

Instructions

Retrieves detailed information for a specific in-app message.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
inAppMessageIdYes

Implementation Reference

  • The handler function for the 'in-app-message-detail' tool. It takes inAppMessageId, fetches the details from the Hackle API using WebClient.get, stringifies the JSON response, and returns it as text content.
    async ({ inAppMessageId }) => {
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(await WebClient.get(`/api/v1/in-app-messages/${inAppMessageId}`)),
          },
        ],
      };
    },
  • Zod input schema requiring a single parameter: inAppMessageId as a number.
    {
      inAppMessageId: z.number(),
    },
  • src/index.ts:94-110 (registration)
    Registration of the 'in-app-message-detail' tool using McpServer.tool method, specifying name, description, input schema, and handler function.
    server.tool(
      'in-app-message-detail',
      'Retrieves detailed information for a specific in-app message.',
      {
        inAppMessageId: z.number(),
      },
      async ({ inAppMessageId }) => {
        return {
          content: [
            {
              type: 'text',
              text: JSON.stringify(await WebClient.get(`/api/v1/in-app-messages/${inAppMessageId}`)),
            },
          ],
        };
      },
    );
  • WebClient.get static method, which performs the HTTP GET request to the Hackle API, used by the tool handler.
    public static async get<T = unknown>(path: string, options?: Omit<RequestInit, 'method'>): Promise<T> {
      return this.request<T>('GET', path, options);
    }
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 this is a retrieval operation, implying it's read-only and non-destructive, but doesn't cover aspects like authentication requirements, rate limits, error conditions, or the format/scope of the returned details. This leaves significant gaps for a tool that presumably fetches sensitive message 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, clear sentence with no wasted words. It's front-loaded with the core action ('retrieves detailed information'), making it easy to scan and understand 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 complexity of retrieving message details (likely involving permissions or data structures), no annotations, and no output schema, the description is insufficient. It doesn't explain what 'detailed information' includes, potential side effects, or error handling, leaving the agent under-informed for safe and effective use.

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 description implies the tool requires an 'inAppMessageId' to identify a specific message, which aligns with the single required parameter in the schema. However, with 0% schema description coverage, the description doesn't add meaningful details beyond this basic inference—it doesn't explain what an inAppMessageId is, its format, or where to obtain it. The baseline is 3 due to the single parameter being straightforward.

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 ('retrieves') and resource ('detailed information for a specific in-app message'), making the purpose unambiguous. However, it doesn't explicitly differentiate from its sibling 'in-app-message-list', which likely lists multiple messages rather than retrieving details for a specific one.

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 prerequisites (e.g., needing an inAppMessageId), exclusions, or comparisons to siblings like 'in-app-message-list' for listing messages or other *-detail tools for different resources.

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