@mondaydotcomorg/atp-client
Version:
Client SDK for Agent Tool Protocol
56 lines • 2.06 kB
TypeScript
import type { SearchOptions, SearchResult, ExploreResult } from '@mondaydotcomorg/atp-protocol';
import type { RuntimeAPIName } from '@mondaydotcomorg/atp-runtime';
import type { ISession } from './session.js';
import type { InProcessSession } from './in-process-session.js';
export declare class APIOperations {
private session;
private inProcessSession?;
private apiDefinitions?;
constructor(session: ISession, inProcessSession?: InProcessSession);
/**
* Connects to the server and retrieves API definitions.
*/
connect(options?: {
apiGroups?: string[];
}): Promise<{
serverVersion: string;
capabilities: unknown;
apiGroups: string[];
}>;
/**
* Gets the TypeScript type definitions for available APIs.
*/
getTypeDefinitions(): string;
/**
* Searches for available API functions.
*/
searchAPI(query: string, options?: SearchOptions): Promise<SearchResult[]>;
/**
* Explores the API filesystem at the given path.
*/
exploreAPI(path: string): Promise<ExploreResult>;
/**
* Gets information about the server.
*/
getServerInfo(): Promise<{
version: string;
capabilities: Record<string, boolean>;
}>;
/**
* Gets ATP runtime API definitions as TypeScript declarations.
* Returns the full TypeScript definitions for atp.llm.*, atp.cache.*, etc.
* These are the APIs available during code execution.
*
* Behavior:
* - No options: Returns APIs based on client capabilities (default filtering)
* - apis: ['llm', 'cache']: Returns only specified APIs (intersection with client capabilities)
* - apis: []: Returns all APIs regardless of client capabilities
*
* @param options - Optional filtering options
* @param options.apis - Specific APIs to include (e.g., ['llm', 'cache', 'approval'])
*/
getRuntimeDefinitions(options?: {
apis?: RuntimeAPIName[];
}): Promise<string>;
}
//# sourceMappingURL=api-operations.d.ts.map