@hashgraphonline/standards-agent-kit/src/tools/hcs10/ListConnectionsTool.ts

A modular SDK for building on-chain autonomous agents using Hashgraph Online Standards, including HCS-10 for agent discovery and communication.

import { z } from 'zod';
import { BaseHCS10QueryTool } from './base-hcs10-tools';
import { HCS10QueryToolParams } from './hcs10-tool-params';

/**
 * A tool to list currently active HCS-10 connections stored in the state manager.
 * Enhanced to show more details similar to moonscape's implementation.
 */
const ListConnectionsZodSchema = z.object({
  includeDetails: z
    .boolean()
    .optional()
    .describe(
      'Whether to include detailed information about each connection'
    ),
  showPending: z
    .boolean()
    .optional()
    .describe('Whether to include pending connection requests'),
});

export class ListConnectionsTool extends BaseHCS10QueryTool<
  typeof ListConnectionsZodSchema
> {
  name = 'list_connections';
  description =
    'Lists all active HCS-10 connections. Use this FIRST before sending messages to check if you already have an active connection to a target agent. Shows connection details and agent information for each active connection.';
  specificInputSchema = ListConnectionsZodSchema;
  constructor(params: HCS10QueryToolParams) {
    super(params);
  }

  protected async executeQuery(
    args: z.infer<typeof ListConnectionsZodSchema>
  ): Promise<unknown> {
    const hcs10Builder = this.hcs10Builder;
    const params: { includeDetails?: boolean; showPending?: boolean } = {};
    if (args.includeDetails !== undefined) {
      params.includeDetails = args.includeDetails;
    }
    if (args.showPending !== undefined) {
      params.showPending = args.showPending;
    }
    await hcs10Builder.listConnections(params);

    const result = await hcs10Builder.execute();

    if (result.success && 'rawResult' in result && result.rawResult) {
      const raw = result.rawResult as { formattedOutput?: string; message?: string };
      return {
        success: true,
        data: raw.formattedOutput || raw.message || 'Connections listed'
      };
    }

    return result;
  }
}