設定

すべての Kazzle アプリは、プロジェクトルートに kazzle.config.ts を持ちます。このファイルは 1 つのアプリ定義をエクスポートします。これは、Kazzle が公開アプリと組み込みコネクタに使用するのと同じコントラクトです。

クイックスタート

import { defineApp } from '@kazzle/app';

export default defineApp({
  schemaVersion: 1,
  name: 'My App',
  subtitle: 'A short catalog description',
  description: { type: 'markdown', path: 'README.md' },
  maxInstallations: 1,
  setup: { type: 'none' },
  launch: { type: 'component', component: 'web' },
  components: [{ name: 'web', type: 'ui', path: '.' }],
  tools: [],
  skills: [],
});

defineApp は定義を検証し、TypeScript のオートコンプリートを提供します。サポートされていないフィールドまたはスペルミスのあるフィールドは無視されるのではなく、検証に失敗します。

定義フィールド

フィールド	型	必須	説明
`schemaVersion`	`1`	はい	定義コントラクトのバージョン。
`name`	`string`	はい	カタログと詳細ページに表示される名前。
`subtitle`	`string`	はい	1 行のカタログ説明。
`description`	`{ type: 'markdown', path: string }`	はい	アプリにバンドルされた Markdown（通常は `README.md`）。
`version`	`string`	いいえ	インストール済みアプリと共に表示されるパブリッシャーバージョン。
`icon`	`string`	いいえ	アプリルートからの相対アイコンパス。
`accentColor`	hex color	いいえ	ブランドアクセントカラー。
`maxInstallations`	`number \| null`	はい	Space ごとの最大インストール数。`null` は無制限を許可します。
`setup`	setup object	はい	インストールの設定方法。
`launch`	launch object	はい	インストール後に開くもの。
`components`	component[]	はい	UI とプロセスコンポーネント。
`tools`	tool source[]	はい	呼び出し可能な AI ツールにコンパイルされるソース。
`skills`	skill[]	はい	関連する場合に読み込まれる指示。
`kazzleAuth`	`'optional' \| 'required'`	いいえ	ローンチサーフェスが Kazzle ID を必要とするかどうか。
`webhookUrl`	URL	いいえ	インストールライフサイクルウェブフックを受け取ります。
`appLogin`	`boolean`	いいえ	アプリ独自のエンドユーザーログインを有効にします。

セットアップ

アプリは正確に 1 つのセットアップフローを選択します。

setup: { type: 'none' }

インストールが外部認可を必要としない場合は none を使用します。

setup: {
  type: 'oauth',
  version: '2.0',
  metadata: {
    type: 'endpoints',
    authorizationUrl: 'https://provider.example.com/oauth/authorize',
    tokenUrl: 'https://provider.example.com/oauth/token',
  },
  scopes: ['account.read'],
  pkce: 'required',
  authorizationParams: {},
  fields: [],
}

OAuth 1.0a または OAuth 2.0 には oauth を使用します。OAuth クライアント認証情報は、アプリが公開されるときにプライベートに設定され、定義には表示されません。

setup: {
  type: 'form',
  labelField: 'accountUrl',
  fields: [
    { key: 'accountUrl', label: 'Account URL', kind: 'url', required: true, secret: false },
    { key: 'apiKey', label: 'API key', kind: 'password', required: true, secret: true },
  ],
}

フォームフィールドは text、password、url、hostname、email、select をサポートします。labelField は、複数のインストールを区別するために非シークレットフィールドを参照できます。

ローンチ

launch: { type: 'none' }
launch: { type: 'component', component: 'web' }
launch: { type: 'url', url: 'https://example.com', target: 'external' }

コンポーネントターゲットは、同じ定義内のコンポーネントに名前を付ける必要があります。URL ターゲットは embedded または external を明示的に選択します。

コンポーネント

各コンポーネントは、一意の name、ui または process の type、およびソース path を持ちます。アプリは最大 1 つの UI コンポーネントを持つことができます。

components: [{
  name: 'server',
  type: 'process',
  path: './server',
  runtime: {
    dev: { command: 'bun run dev' },
    prod: { command: 'bun run start', build: 'bun run build' },
  },
}]

env はコンポーネントのシークレットコレクションと環境を選択できます。プロセスコンポーネントは、永続的またはトリガーされた実行と、名前付きスケジュールまたはウェブフックトリガーを宣言することもできます。

ツールとスキル

ツールとスキルは独立しています。ツールは呼び出し可能な操作を定義します。スキルは、それらをいつどのように使用するかを説明します。

tools: [
  { name: 'app-tools', type: 'file', path: './tools.ts' },
  {
    name: 'stripe',
    type: 'connection_actions',
    actions: ['customers.list', 'invoices.list'],
  },
],
skills: [
  { name: 'billing', source: { type: 'file', path: './skills/billing/SKILL.md' } },
  { name: 'review', source: { type: 'inline', instructions: 'Confirm before write actions.' } },
]

接続アクションは、呼び出されるときにインストールが必要です。これらは Kazzle のシステムアプリコンバーターによって生成されます。公開アプリはファイル内で呼び出し可能なツールを定義します。スキルは独立したままで、関連する場合にのみ読み込むことができます。

はじめに

作成

ユーザーとデータ

公開

Kazzle の使い方

セキュリティ

リファレンス

設定

設定

クイックスタート

定義フィールド

セットアップ

ローンチ

コンポーネント

ツールとスキル

​設定

​クイックスタート

​定義フィールド

​セットアップ

​ローンチ

​コンポーネント

​ツールとスキル

設定

クイックスタート

定義フィールド

セットアップ

ローンチ

コンポーネント

ツールとスキル