SDK
Dropstone サーバーの型安全な JS クライアント。
Dropstone JS/TS SDK は、ローカル Dropstone エージェントと対話するための型安全なクライアントを提供します。dropstone serve をサブプロセスとして起動し、それに向けた型付き HTTP クライアントを提供します。
CI でヘッドレス API アクセスが必要ですか?:
純粋なプログラマティック用途(CI パイプライン、自動化、サーバーレス)の場合は、DROPSTONE_API_KEY を使用した HTTP API を推奨します。このページの SDK は、CLI バイナリがインストールされている Node プロセスに対話型エージェントを埋め込むことを目的としています。
基盤となる HTTP API の動作については、Server ページを参照してください。
インストール
npm から SDK をインストールします:
npm install @blankline/dropstone-sdk
クライアントの作成
Dropstone のインスタンスを作成します:
import { createDropstone } from "@blankline/dropstone-sdk"
const { client } = await createDropstone()
これはサーバーとクライアントの両方を起動します
オプション
| オプション | 型 | 説明 | デフォルト |
|---|---|---|---|
hostname | string | サーバーホスト名 | 127.0.0.1 |
port | number | サーバーポート | 4096 |
signal | AbortSignal | キャンセル用中止シグナル | undefined |
timeout | number | サーバー起動のタイムアウト(ミリ秒) | 5000 |
config | Config | 設定オブジェクト | {} |
設定
設定オブジェクトを渡して動作をカスタマイズできます。インスタンスは引き続き 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(`Server running at ${dropstone.server.url}`)
dropstone.server.close()
クライアントのみ
既に実行中の Dropstone インスタンスがある場合は、クライアント インスタンスを作成して接続できます:
import { createDropstoneClient } from "@blankline/dropstone-sdk"
const client = createDropstoneClient({
baseUrl: "http://localhost:4096",
})
オプション
| オプション | 型 | 説明 | デフォルト |
|---|---|---|---|
baseUrl | string | サーバーの URL | http://localhost:4096 |
fetch | function | カスタム fetch 実装 | globalThis.fetch |
parseAs | string | レスポンス解析方法 | auto |
responseStyle | string | 戻り値スタイル: data または fields | fields |
throwOnError | boolean | エラーをスローする | false |
型
SDK には、すべての API 型の TypeScript 定義が含まれています。直接インポートしてください:
import type { Session, Message, Part } from "@blankline/dropstone-sdk"
すべての型はサーバーの OpenAPI 仕様から生成されるため、TypeScript で見られる名前は server のリクエストとレスポンス形状に 1 対 1 でマップされます。
エラー
SDK はキャッチして処理できるエラーをスローできます:
try {
await client.session.get({ path: { id: "invalid-id" } })
} catch (error) {
console.error("Failed to get session:", (error as Error).message)
}
構造化出力
JSON スキーマを指定した format を使用して、モデルから構造化 JSON 出力をリクエストできます。モデルは StructuredOutput ツールを使用して、スキーマに一致する検証済み JSON を返します。
基本的な使用方法
const result = await client.session.prompt({
path: { id: sessionId },
body: {
parts: [{ type: "text", text: "Research Dropstone and provide company info" }],
format: {
type: "json_schema",
schema: {
type: "object",
properties: {
company: { type: "string", description: "Company name" },
founded: { type: "number", description: "Year founded" },
products: {
type: "array",
items: { type: "string" },
description: "Main products",
},
},
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 スキーマ モードを指定 |
schema | object | 必須。出力構造を定義する JSON スキーマ オブジェクト |
retryCount | number | オプション。検証再試行回数(デフォルト: 2) |
エラー処理
モデルがすべての再試行後に有効な構造化出力を生成できない場合、レスポンスには StructuredOutputError が含まれます:
if (result.data.info.error?.name === "StructuredOutputError") {
console.error("Failed to produce structured output:", result.data.info.error.message)
console.error("Attempts:", result.data.info.error.retries)
}
ベストプラクティス
- スキーマ プロパティに明確な説明を提供 して、モデルが抽出するデータを理解するのに役立てます
requiredを使用 して、どのフィールドが存在する必要があるかを指定します- スキーマをシンプルに保つ - 複雑にネストされたスキーマはモデルが正しく入力するのが難しい場合があります
- 適切な
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: "Operation completed",
},
})
// 利用可能なエージェントをリスト
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: "My session" },
})
const sessions = await client.session.list()
// プロンプト メッセージを送信
const result = await client.session.prompt({
path: { id: session.id },
body: {
model: { providerID: "dropstone", modelID: "dropstone-pro" },
parts: [{ type: "text", text: "Hello!" }],
},
})
// AI レスポンスをトリガーせずにコンテキストを挿入(プラグインに便利)
await client.session.prompt({
path: { id: session.id },
body: {
noReply: true,
parts: [{ type: "text", text: "You are a helpful assistant." }],
},
})
ファイル
| メソッド | 説明 | レスポンス |
|---|---|---|
find.text({ query }) | ファイル内のテキストを検索 | path、lines、line_number、absolute_offset、submatches を含むマッチ オブジェクトの配列 |
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:", event.type, event.properties)
}