Dropstone Docs

Dropstone SDK

Dropstone エージェントランタイム向けの型安全な JS クライアント。SDK セッションは Dropstone のクロスサーフェスメモリ(Continuity)を継承します — CLI、チャット、SDK と共有される単一の永続メモリです。

Dropstone JS/TS SDK は、Dropstone エージェントランタイムと対話するための型安全なクライアントを提供します。dropstone serve をサブプロセスとして起動し、それに向けた型付き HTTP クライアントを提供します。CLI が使用するのと同じローカルエージェントを実行するため、すべての SDK セッションはアカウントメモリを継承します — CLI、チャット、SDK のいずれかで一度教えれば、すべてのサーフェスがそれを認識します(Memory (Continuity) を参照)。

CI でヘッドレス API アクセスが必要ですか?:

純粋なプログラム利用(CI パイプライン、自動化、サーバーレス)には、DROPSTONE_API_KEY を使用した HTTP API を推奨します。このページの SDK は、CLI バイナリが一緒にインストールされている Node プロセスにインタラクティブエージェントを組み込むことを目的としています。

基盤となる HTTP API の仕組みについては、Server ページを参照してください。


インストール

npm から SDK をインストールします:

npm install @blankline/dropstone-sdk

ヘッドレス API クライアント

CI パイプライン、自動化、サーバーレスには CLI はまったく必要ありません。API キーを使用して Dropstone HTTP API に直接通信するヘッドレスクライアントを使用してください:

import { createDropstoneApi } from "@blankline/dropstone-sdk"

// 環境から DROPSTONE_API_KEY を自動的に読み取ります。
const dropstone = createDropstoneApi()

const resp = await dropstone.chat.completions.create({
  model: "dropstone-fast", // または "dropstone-pro" / "dropstone-heavy"
  messages: [{ role: "user", content: "デバッグについて俳句を書いてください。" }],
})

console.log(resp.choices[0].message.content)
console.log("コスト: $" + resp.usage?.cost) // 請求額(USD)

API キーの取得

  1. dropstone.io/dashboard にサインインします。
  2. dropstone.io/dashboard/settingsSettings → API を開き、キーを作成します — dsk_live_<43文字> の形式です。
  3. 環境変数として設定します(または createDropstoneApiapiKey を渡します):
export DROPSTONE_API_KEY=dsk_live_...

Note:

API キーはパスワードのように扱ってください。git にコミットしたり、フロントエンドバンドルに埋め込んだりしないでください。API キーを使用したリクエストは、プリペイド残高から従量課金されます — プランの利用枠は適用されません。Usage & limits を参照してください。

ストリーミングも同様に機能し、クライアントは OpenAI 互換です — OpenAI SDK を Dropstone のベース URL に向けることもできます:

const stream = await dropstone.chat.completions.create({
  model: "dropstone-fast",
  stream: true,
  messages: [{ role: "user", content: "5まで数えてください。" }],
})

for await (const chunk of stream) {
  process.stdout.write(chunk.choices?.[0]?.delta?.content ?? "")
}

完全なリファレンスについては HTTP API ページを参照してください。


クライアントの作成

dropstone のインスタンスを作成します:

import { createDropstone } from "@blankline/dropstone-sdk"

const { client } = await createDropstone()

これによりサーバーとクライアントの両方が起動します。すべての SDK メソッドは { data, request, response } を返すため、ペイロードには .data でアクセスします。

オプション

オプション説明デフォルト
hostnamestringサーバーのホスト名127.0.0.1
portnumberサーバーのポート4096
signalAbortSignalキャンセル用のアボートシグナルundefined
timeoutnumberサーバー起動のタイムアウト(ms)5000
configConfig設定オブジェクト{}

設定

動作をカスタマイズするために設定オブジェクトを渡すことができます。インスタンスは引き続き dropstone.json を読み取りますが、設定をインラインで上書きまたは追加できます:

import { createDropstone } from "@blankline/dropstone-sdk"

const dropstone = await createDropstone({
  hostname: "127.0.0.1",
  port: 4096,
  config: {
    model: "dropstone/dropstone-pro",
  },
})

console.log(`サーバーが ${dropstone.server.url} で実行中です`)

dropstone.server.close()

メモリ(Continuity)

Dropstone はアカウントごとに 1 つの永続メモリを保持します。これを Continuity と呼びます — CLI、チャット、VS Code、SDK で共有されるクロスサーフェスメモリです。どこでも一度教えれば、すべてのサーフェスがそれを認識します。

SDK を通じて実行するセッションは、CLI と同じアカウントメモリを使用します。CLI で教えたことは SDK セッションですでに認識されており、SDK セッションが記録したことは CLI とチャットで利用できます。毎ターン、エージェントは応答する前に関連メモリを自動的に呼び出し、すでに知っていることを再学習しません。

SDK エージェントは、CLI と同じツールを使用してメモリを直接読み書きすることもできます:

ツール目的
memory_recall現在のタスクに最も関連する教訓を呼び出す
record_lesson永続的な教訓(ルールまたは事実)を保存する
list_lessonsあなたについて学習したすべてを表示する
forget_lesson教訓を削除する

Note:

メモリを使用するには Dropstone にサインインしている必要があります。SDK サーバーは CLI と同じ auth.json を読み取るため、dropstone で一度サインインすれば、SDK セッションは同じアカウントメモリを継承します。サインインしていない場合、何も保存されません。

コードから設定を指定すると、CLI と同じ方法で記録されます — その後 CLI とチャットで表示されます:

const { client } = await createDropstone()

const session = await client.session.create({ body: { title: "メモリを教える" } })

await client.session.prompt({
  path: { id: session.data.id },
  body: {
    parts: [{ type: "text", text: "これを常設ルールとして覚えてください: 常に bun を使用し、npm は使わない。" }],
  },
})

Continuity と AGENTS.md の違い

AGENTS.md はチームの規約のために Git にコミットするプロジェクトファイルです — 安定しており、リポジトリにスコープされ、クローンするすべての人と共有されます。Continuity はあなたのプライベートなアカウントメモリです — CLI、チャット、または SDK で教えたことが、サーフェスやプロジェクトを超えてアカウントに追従します。これらは異なる問題を解決し、一緒に使用するのが最適です — プロジェクトルールは AGENTS.md、個人のクロスサーフェスメモリは Continuity に。RulesMemory を参照してください。

記憶される内容

メモリには、明示的に教えたルールと事実のみが保存されます — セッションを超えて引き継ぐ価値のある設定、規約、修正などです。これは単一セッションの一時的なコンテキストとは異なり、セッション終了後は保持されません。

Dropstone が何を保持するかを決定する方法については、Memory ページを参照してください。


クライアントのみ

すでに実行中の dropstone インスタンスがある場合は、クライアントインスタンスを作成して接続できます:

import { createDropstoneClient } from "@blankline/dropstone-sdk"

const client = createDropstoneClient({
  baseUrl: "http://localhost:4096",
})

オプション

オプション説明デフォルト
baseUrlstringサーバーの URLhttp://localhost:4096
fetchfunctionカスタム fetch 実装globalThis.fetch
parseAsstringレスポンス解析方法auto
responseStylestring戻り値スタイル: data または fieldsfields
throwOnErrorbooleanエラーを返す代わりにスローするfalse

SDK にはすべての API 型の TypeScript 定義が含まれています。直接インポートできます:

import type { Session, Message, Part } from "@blankline/dropstone-sdk"

すべての型はサーバーの OpenAPI 仕様から生成されているため、TypeScript で表示される名前は server のリクエストおよびレスポンスの形状と一対一で対応します。


エラー

SDK はキャッチして処理できるエラーをスローできます:

try {
  await client.session.get({ path: { id: "invalid-id" } })
} catch (error) {
  console.error("セッションの取得に失敗しました:", (error as Error).message)
}

構造化出力

JSON スキーマを指定した format を指定することで、モデルから構造化された JSON 出力を要求できます。モデルは StructuredOutput ツールを使用して、スキーマに一致する検証済み JSON を返します。

基本的な使用方法

const result = await client.session.prompt({
  path: { id: sessionId },
  body: {
    parts: [{ type: "text", text: "Dropstone を調査して会社情報を提供してください" }],
    format: {
      type: "json_schema",
      schema: {
        type: "object",
        properties: {
          company: { type: "string", description: "会社名" },
          founded: { type: "number", description: "設立年" },
          products: {
            type: "array",
            items: { type: "string" },
            description: "主要製品",
          },
        },
        required: ["company", "founded"],
      },
    },
  },
})

// 構造化出力にアクセス
console.log(result.data.info.structured_output)
// { company: "Dropstone", founded: 2024, products: ["Dropstone CLI"] }

出力形式の種類

説明
textデフォルト。標準テキストレスポンス(構造化出力なし)
json_schema指定されたスキーマに一致する検証済み JSON を返す

JSON スキーマ形式

type: 'json_schema' を使用する場合、以下を指定します:

フィールド説明
type'json_schema'必須。JSON スキーマモードを指定します
schemaobject必須。出力構造を定義する JSON スキーマオブジェクト
retryCountnumber任意。検証リトライ回数(デフォルト: 2)

エラーハンドリング

モデルがすべてのリトライ後に有効な構造化出力を生成できない場合、レスポンスには StructuredOutputError が含まれます:

if (result.data.info.error?.name === "StructuredOutputError") {
  console.error("構造化出力の生成に失敗しました:", result.data.info.error.message)
  console.error("試行回数:", result.data.info.error.retries)
}

ベストプラクティス

  1. スキーマプロパティに明確な説明を提供して、モデルが抽出するデータを理解できるようにします
  2. required を使用して、必須フィールドを指定します
  3. スキーマを焦点を絞ったものに保つ — 複雑なネストされたスキーマはモデルが正しく埋めるのが難しい場合があります
  4. 適切な retryCount を設定 — 複雑なスキーマでは増やし、単純なものでは減らします

API

SDK はすべてのサーバー API を型安全なクライアントを通じて公開します。


グローバル

メソッド説明レスポンス
global.health()サーバーのヘルスとバージョンを確認{ healthy: true, version: string }

const health = await client.global.health()
console.log(health.data.version)

アプリ

メソッド説明レスポンス
app.log()ログエントリを書き込むboolean
app.agents()利用可能なエージェントを一覧表示Agent[]

// ログエントリを書き込む
await client.app.log({
  body: {
    service: "my-app",
    level: "info",
    message: "操作が完了しました",
  },
})

// 利用可能なエージェントを一覧表示
const agents = await client.app.agents()

プロジェクト

メソッド説明レスポンス
project.list()すべてのプロジェクトを一覧表示Project[]
project.current()現在のプロジェクトを取得Project

// すべてのプロジェクトを一覧表示
const projects = await client.project.list()

// 現在のプロジェクトを取得
const currentProject = await client.project.current()

パス

メソッド説明レスポンス
path.get()現在のパスを取得Path

// 現在のパス情報を取得
const pathInfo = await client.path.get()

設定

メソッド説明レスポンス
config.get()設定情報を取得Config

const config = await client.config.get()

セッション

メソッド説明備考
session.list()セッションを一覧表示Session[] を返します
session.get({ path })セッションを取得Session を返します
session.children({ path })子セッションを一覧表示Session[] を返します
session.create({ body })セッションを作成Session を返します
session.delete({ path })セッションを削除boolean を返します
session.update({ path, body })セッションプロパティを更新Session を返します
session.init({ path, body })アプリを分析して AGENTS.md を作成boolean を返します
session.abort({ path })実行中のセッションを中止boolean を返します
session.summarize({ path, body })セッションを要約boolean を返します
session.messages({ path })セッション内のメッセージを一覧表示{ info: Message, parts: Part[]}[] を返します
session.message({ path })メッセージの詳細を取得{ info: Message, parts: Part[]} を返します
session.prompt({ path, body })プロンプトメッセージを送信body.noReply: true は UserMessage(コンテキストのみ)を返します。デフォルトは AI 応答を含む AssistantMessage を返します。構造化出力 には body.outputFormat をサポートします
session.command({ path, body })セッションにコマンドを送信{ info: AssistantMessage, parts: Part[]} を返します
session.shell({ path, body })シェルコマンドを実行AssistantMessage を返します
session.revert({ path, body })メッセージを元に戻すSession を返します
session.unrevert({ path })元に戻したメッセージを復元Session を返します
postSessionByIdPermissionsByPermissionId({ path, body })権限リクエストに応答boolean を返します

// セッションの作成と管理
const session = await client.session.create({
  body: { title: "マイセッション" },
})

const sessions = await client.session.list()

// プロンプトメッセージを送信
const result = await client.session.prompt({
  path: { id: session.data.id },
  body: {
    model: { providerID: "dropstone", modelID: "dropstone-pro" },
    parts: [{ type: "text", text: "こんにちは!" }],
  },
})

// AI 応答をトリガーせずにコンテキストを注入(プラグインに便利)
await client.session.prompt({
  path: { id: session.data.id },
  body: {
    noReply: true,
    parts: [{ type: "text", text: "あなたは役立つアシスタントです。" }],
  },
})

ファイル

メソッド説明レスポンス
find.text({ query })ファイル内のテキストを検索pathlinesline_numberabsolute_offsetsubmatches を含む一致オブジェクトの配列
find.files({ query })名前でファイルとディレクトリを検索string[](パス)
find.symbols({ query })ワークスペースシンボルを検索Symbol[]
file.read({ query })ファイルを読み取る{ type: "raw" | "patch", content: string }
file.status({ query? })追跡ファイルのステータスを取得File[]

find.files はいくつかのオプションのクエリフィールドをサポートしています:

  • type: "file" または "directory"
  • directory: 検索のプロジェクトルートを上書き
  • limit: 最大結果数(1〜200)

// ファイルの検索と読み取り
const textResults = await client.find.text({
  query: { pattern: "function.*dropstone" },
})

const files = await client.find.files({
  query: { query: "*.ts", type: "file" },
})

const directories = await client.find.files({
  query: { query: "packages", type: "directory", limit: 20 },
})

const content = await client.file.read({
  query: { path: "src/index.ts" },
})

認証

メソッド説明レスポンス
auth.set({ ... })認証情報を設定boolean

await client.auth.set({
  path: { id: "dropstone" },
  body: { type: "api", key: "your-dropstone-api-key" },
})

イベント

メソッド説明レスポンス
event.subscribe()サーバー送信イベントストリームサーバー送信イベントストリーム

// リアルタイムイベントをリッスン
const events = await client.event.subscribe()
for await (const event of events.stream) {
  console.log("イベント:", event.type, event.properties)
}

v2 API

SDK には、安定した v1 サーフェス(上記の例で使用)と、新しい Effect HttpApi コントラクトを反映した v2 サーフェスが含まれています。新しい統合には v2 を推奨します:

import { createDropstone } from "@blankline/dropstone-sdk/v2"

const { client, server } = await createDropstone()
// v2 はより豊富なリソース階層を公開します: workspace、worktree、file、find など
const files = await client.file.list({ path: "src" })

v1 サーフェスは後方互換性のために維持されています。新しいエンドポイントは v2 にのみ追加されます。

Ctrl+I