Skip to main content
Glama

ping

Verify configured credentials and return account identity details to confirm authentication before creating or exporting presentations.

Instructions

Verify the configured Alai credentials and return account identity details. Use this first when you need to confirm authentication before creating or exporting presentations.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • src/index.js:99-113 (registration)
    Registration of the 'ping' tool via server.registerTool with name 'ping', description, empty inputSchema, and an async handler.
    server.registerTool(
      "ping",
      {
        description:
          "Verify the configured Alai credentials and return account identity details. Use this first when you need to confirm authentication before creating or exporting presentations.",
        inputSchema: {},
      },
      async () => {
        try {
          return await callRemoteTool("ping", {});
        } catch (error) {
          return normalizeError(error);
        }
      },
    );
  • Handler function for the 'ping' tool. Calls callRemoteTool('ping', {}) and returns the result, catching errors via normalizeError.
    async () => {
      try {
        return await callRemoteTool("ping", {});
      } catch (error) {
        return normalizeError(error);
      }
    },
  • Input schema for the 'ping' tool is an empty object (inputSchema: {}), meaning it takes no arguments.
    "ping",
    {
  • The callRemoteTool helper function that creates an MCP client, connects via StreamableHTTPClientTransport, and calls client.callTool with the tool name and arguments.
    async function callRemoteTool(name, args) {
      const client = new Client(
        { name: "alai-mcp-wrapper", version: "1.0.2" },
        { capabilities: {} },
      );
      const transport = new StreamableHTTPClientTransport(new URL(REMOTE_MCP_URL), {
        requestInit: {
          headers: createRemoteHeaders(),
        },
      });
    
      try {
        await client.connect(transport);
        return await client.callTool({
          name,
          arguments: args,
        });
      } finally {
        await transport.close().catch(() => {});
        await client.close().catch(() => {});
      }
    }
Behavior3/5

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

No annotations provided, so description carries full burden. It discloses the action (verification) and output (identity details) but omits potential side effects or error scenarios. Adequate for a simple ping.

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?

Two concise sentences: first states purpose, second gives usage context. No wasted words, front-loaded with key action.

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 tool with no parameters and no output schema, the description sufficiently explains purpose and usage. Could mention error handling or latency, but contextually complete for its simplicity.

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?

No parameters exist, and schema coverage is 100%. Description does not need to add parameter info, so baseline score applies.

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?

Clearly states the verb 'verify' and the resource 'Alai credentials', and specifies the return of 'account identity details'. Differentiates from sibling tools focused on presentation manipulation.

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

Usage Guidelines4/5

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

Explicitly advises using this tool before creating or exporting presentations to confirm authentication. Does not mention when not to use, but provides clear positive guidance.

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/getalai/alai-mcp-server'

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