SDK API Reference

npm install @protolabsai/sdk

import { query } from '@protolabsai/sdk';
 
const conversation = query({
  prompt: 'What files are in the current directory?',
  options: { cwd: '/path/to/project' },
});
 
for await (const message of conversation) {
  console.log(message);
}

import {
  isTextMessage,
  isToolUseMessage,
  isResultMessage,
  isLspDiagnosticEvent,
  abortQuery,
} from '@protolabsai/sdk';

async function* conversation() {
  yield { type: 'human', content: 'Analyse the project structure' };
  yield { type: 'human', content: 'Now write a summary to README.md' };
}
 
const session = query({ prompt: conversation() });
for await (const msg of session) { ... }

const controller = new AbortController();
const session = query({ prompt: '...', options: { abortController: controller } });
 
setTimeout(() => controller.abort(), 30_000);
 
for await (const msg of session) { ... }

import { query, type HookCallback } from '@protolabsai/sdk';
 
const gate: HookCallback = async (input) => {
  const data = input as {
    tool_name?: string;
    tool_input?: Record<string, unknown>;
  };
  if (data.tool_name === 'Bash') {
    const cmd = String(data.tool_input?.command ?? '');
    if (cmd.includes('rm -rf')) {
      return { shouldSkip: true, message: 'Blocked destructive command' };
    }
  }
  return {};
};
 
const session = query({
  prompt: 'Clean up old files',
  options: { hookCallbacks: { PreToolUse: [gate] } },
});

import { query, type SubagentConfig } from '@protolabsai/sdk';
 
const reviewer: SubagentConfig = {
  name: 'code-reviewer',
  description: 'Reviews code for bugs, security, and performance',
  systemPrompt: 'You are a code reviewer...',
  level: 'session',
  tools: ['read_file', 'glob', 'grep_search'],
  modelConfig: { model: 'claude-sonnet-4-6' },
};
 
const session = query({
  prompt: 'Review the changes in the current branch',
  options: { agents: [reviewer] },
});