terse-sdk

TypeScript SDK for building jobs on the Terse platform.

Installation

npm install terse-sdk

Quick Start

import { Terse, TerseAgent } from "terse-sdk";
import { GitHub, Slack, Repos, SlackChannel } from "./terse.generated";

const client = new Terse();

client.createJob({
  name: "PR Summary Bot",
  triggers: [GitHub.onPROpened({ repo: Repos.MyOrg.MyRepo })],
  skills: [GitHub.skill({ repos: [Repos.MyOrg.MyRepo] }), Slack.skill({ channel: SlackChannel.General })],
  onTrigger: async (event, Agent) => {
    await Agent.runAndWait(`Summarize this PR: ${event.formatForAgentRunner()}`);
  },
});

Core Concepts

• Terse — Entry point. Use createJob() to register jobs.
• TerseAgent — Passed into your onTrigger handler. Call agent.run() for streaming results or agent.runAndWait() to run to completion.
• Triggers — Config instances (e.g. GitHub.onPROpened()) that define when a job fires.
• Skills — Integration configs (e.g. Slack.skill()) that give the agent access to tools.
• Events — Typed input events (GithubPRInputEvent, WorkOSUserInputEvent, etc.) with type guards like isGithubPREvent().

API

TerseAgent

| Method | Description | |---|---| | run(prompt, event?) | Returns an AsyncGenerator<TerseAgentResult> streaming agent output | | runAndWait(prompt, event?) | Runs the agent to completion, discarding streamed output | | executeTool(toolName, params?) | Directly execute a single tool by name |

Event Types

The SDK provides typed event classes and type guards for supported integrations:

• GitHub: GithubInputEvent, GithubPRInputEvent, GithubPushInputEvent
• WorkOS: WorkOSUserInputEvent, WorkOSMembershipInputEvent, WorkOSInvitationInputEvent

Environment Variables

| Variable | Description | |---|---| | TERSE_API_KEY | Required. API key for authenticating with the Terse platform. |