@databricks/appkit 0.72.0 → 0.73.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (117) hide show
  1. package/CLAUDE.md +17 -0
  2. package/NOTICE.md +1 -0
  3. package/dist/appkit/package.js +1 -1
  4. package/dist/beta.d.ts +7 -4
  5. package/dist/beta.js +3 -2
  6. package/dist/cli/commands/agent/eval.js +9 -1
  7. package/dist/cli/commands/agent/eval.js.map +1 -1
  8. package/dist/connectors/index.js +1 -1
  9. package/dist/connectors/mlflow/auth.d.ts +11 -1
  10. package/dist/connectors/mlflow/auth.d.ts.map +1 -1
  11. package/dist/connectors/mlflow/auth.js +22 -2
  12. package/dist/connectors/mlflow/auth.js.map +1 -1
  13. package/dist/connectors/mlflow/index.d.ts +2 -0
  14. package/dist/database/errors.js +15 -5
  15. package/dist/database/errors.js.map +1 -1
  16. package/dist/database/runtime/data-path.d.ts +7 -0
  17. package/dist/database/runtime/data-path.d.ts.map +1 -0
  18. package/dist/database/runtime/data-path.js.map +1 -1
  19. package/dist/database/runtime/engine/drizzle-data-path.js +7 -5
  20. package/dist/database/runtime/engine/drizzle-data-path.js.map +1 -1
  21. package/dist/database/schema-builder/define-schema.d.ts +1 -1
  22. package/dist/database/schema-builder/define-schema.js +1 -1
  23. package/dist/database/schema-builder/define-schema.js.map +1 -1
  24. package/dist/errors/database-validation.d.ts +23 -0
  25. package/dist/errors/database-validation.d.ts.map +1 -0
  26. package/dist/errors/database-validation.js +24 -0
  27. package/dist/errors/database-validation.js.map +1 -0
  28. package/dist/errors/index.js +1 -0
  29. package/dist/evals/dataset.d.ts +36 -0
  30. package/dist/evals/dataset.d.ts.map +1 -0
  31. package/dist/evals/dataset.js +36 -0
  32. package/dist/evals/dataset.js.map +1 -0
  33. package/dist/evals/http-driver.js +56 -51
  34. package/dist/evals/http-driver.js.map +1 -1
  35. package/dist/evals/index.d.ts +14 -0
  36. package/dist/evals/index.js +2 -1
  37. package/dist/evals/judge.d.ts +1 -0
  38. package/dist/evals/judge.d.ts.map +1 -1
  39. package/dist/evals/mlflow-report.d.ts +1 -0
  40. package/dist/evals/mlflow-report.d.ts.map +1 -1
  41. package/dist/evals/mlflow-run.d.ts +2 -0
  42. package/dist/evals/mlflow-run.d.ts.map +1 -1
  43. package/dist/evals/run-eval.d.ts +3 -0
  44. package/dist/evals/run-eval.d.ts.map +1 -1
  45. package/dist/evals/run-eval.js +10 -2
  46. package/dist/evals/run-eval.js.map +1 -1
  47. package/dist/evals/run-evals.d.ts +9 -0
  48. package/dist/evals/run-evals.d.ts.map +1 -1
  49. package/dist/evals/run-evals.js +101 -22
  50. package/dist/evals/run-evals.js.map +1 -1
  51. package/dist/evals/types.d.ts +40 -4
  52. package/dist/evals/types.d.ts.map +1 -1
  53. package/dist/index.d.ts +2 -1
  54. package/dist/index.js +2 -1
  55. package/dist/plugin/plugin.d.ts.map +1 -1
  56. package/dist/plugin/plugin.js +1 -1
  57. package/dist/plugin/plugin.js.map +1 -1
  58. package/dist/plugins/database/crud/contract.js +17 -8
  59. package/dist/plugins/database/crud/contract.js.map +1 -1
  60. package/dist/plugins/database/crud/exposure.js +63 -22
  61. package/dist/plugins/database/crud/exposure.js.map +1 -1
  62. package/dist/plugins/database/crud/request.js +50 -0
  63. package/dist/plugins/database/crud/request.js.map +1 -0
  64. package/dist/plugins/database/crud/response.js +77 -0
  65. package/dist/plugins/database/crud/response.js.map +1 -0
  66. package/dist/plugins/database/crud/routes.js +71 -52
  67. package/dist/plugins/database/crud/routes.js.map +1 -1
  68. package/dist/plugins/database/database.d.ts +6 -4
  69. package/dist/plugins/database/database.d.ts.map +1 -1
  70. package/dist/plugins/database/database.js +46 -16
  71. package/dist/plugins/database/database.js.map +1 -1
  72. package/dist/plugins/database/defaults.js +5 -1
  73. package/dist/plugins/database/defaults.js.map +1 -1
  74. package/dist/plugins/database/entity-client.js +143 -10
  75. package/dist/plugins/database/entity-client.js.map +1 -1
  76. package/dist/plugins/database/entity-types.d.ts +1 -1
  77. package/dist/plugins/database/hooks.d.ts +38 -0
  78. package/dist/plugins/database/hooks.d.ts.map +1 -0
  79. package/dist/plugins/database/index.d.ts +3 -2
  80. package/dist/plugins/database/lifecycle.js +67 -28
  81. package/dist/plugins/database/lifecycle.js.map +1 -1
  82. package/dist/plugins/database/scope.js +58 -0
  83. package/dist/plugins/database/scope.js.map +1 -0
  84. package/dist/plugins/database/types.d.ts +40 -12
  85. package/dist/plugins/database/types.d.ts.map +1 -1
  86. package/dist/shared/src/schemas/manifest.d.ts +33 -33
  87. package/docs/api/appkit/Class.AppKitError.md +1 -0
  88. package/docs/api/appkit/Class.DatabaseValidationError.md +191 -0
  89. package/docs/api/appkit/Function.defineSchema.md +1 -1
  90. package/docs/api/appkit/Function.readEvalDataset.md +21 -0
  91. package/docs/api/appkit/Function.resolveWorkspaceClient.md +18 -0
  92. package/docs/api/appkit/Interface.AssertionHandle.md +1 -1
  93. package/docs/api/appkit/Interface.DatabaseValidationIssue.md +21 -0
  94. package/docs/api/appkit/Interface.DatasetRow.md +21 -0
  95. package/docs/api/appkit/Interface.EntityMutationHooks.md +173 -0
  96. package/docs/api/appkit/Interface.EvalDefinition.md +28 -0
  97. package/docs/api/appkit/Interface.EvalDriver.md +16 -1
  98. package/docs/api/appkit/Interface.HookApp.md +12 -0
  99. package/docs/api/appkit/Interface.HookContext.md +21 -0
  100. package/docs/api/appkit/Interface.ReadEvalDatasetOptions.md +34 -0
  101. package/docs/api/appkit/Interface.ReadSerializerContext.md +21 -0
  102. package/docs/api/appkit/Interface.RunEvalOptions.md +11 -0
  103. package/docs/api/appkit/Interface.RunEvalsOptions.md +22 -0
  104. package/docs/api/appkit/Interface.TestContext.md +41 -4
  105. package/docs/api/appkit/TypeAlias.DatabaseApiConfig.md +53 -0
  106. package/docs/api/appkit/TypeAlias.DatabaseApiWriteOperation.md +8 -0
  107. package/docs/api/appkit/TypeAlias.DatabaseApiWritesConfig.md +49 -0
  108. package/docs/api/appkit/TypeAlias.DatabaseExports.md +3 -3
  109. package/docs/api/appkit/TypeAlias.EntityHooks.md +25 -0
  110. package/docs/api/appkit/TypeAlias.IDatabaseConfig.md +16 -5
  111. package/docs/api/appkit/TypeAlias.ReadSerializer.md +19 -0
  112. package/docs/api/appkit/TypeAlias.TransactionClient.md +19 -0
  113. package/docs/api/appkit.md +135 -119
  114. package/docs/plugins/database.md +144 -0
  115. package/llms.txt +17 -0
  116. package/package.json +2 -2
  117. package/sbom.cdx.json +1 -1
package/docs/api/appkit.md CHANGED
@@ -11,24 +11,25 @@ Documentation merge entry for Typedoc — combines the stable `@databricks/appki
11
11
 
12
12
  ## Classes[​](#classes "Direct link to Classes")
13
13
 
14
- | Class | Description |
15
- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
16
- | [AppKitError](./docs/api/appkit/Class.AppKitError.md) | Base error class for all AppKit errors. Provides a consistent structure for error handling across the framework. |
17
- | [AppKitMcpClient](./docs/api/appkit/Class.AppKitMcpClient.md) | Lightweight MCP client for Databricks-hosted MCP servers. |
18
- | [AuthenticationError](./docs/api/appkit/Class.AuthenticationError.md) | Error thrown when authentication fails. Use for missing tokens, invalid credentials, or authorization failures. |
19
- | [ConfigurationError](./docs/api/appkit/Class.ConfigurationError.md) | Error thrown when configuration is missing or invalid. Use for missing environment variables, invalid settings, or setup issues. |
20
- | [ConnectionError](./docs/api/appkit/Class.ConnectionError.md) | Error thrown when a connection or network operation fails. Use for database pool errors, API failures, timeouts, etc. |
21
- | [DatabricksAdapter](./docs/api/appkit/Class.DatabricksAdapter.md) | Adapter that talks directly to Databricks Model Serving `/invocations` endpoint. |
22
- | [ExecutionError](./docs/api/appkit/Class.ExecutionError.md) | Error thrown when an operation execution fails. Use for statement failures, canceled operations, or unexpected states. |
23
- | [InitializationError](./docs/api/appkit/Class.InitializationError.md) | Error thrown when a service or component is not properly initialized. Use when accessing services before they are ready. |
24
- | [MlflowClient](./docs/api/appkit/Class.MlflowClient.md) | A thin client over the Databricks workspace REST API, owning the host + bearer token so callers (eval-run creation, assessment writes, the judge's serving endpoint) don't each re-derive URLs or re-attach auth. The host is normalized once at construction. |
25
- | [Plugin](./docs/api/appkit/Class.Plugin.md) | Base abstract class for creating AppKit plugins. |
26
- | [PolicyDeniedError](./docs/api/appkit/Class.PolicyDeniedError.md) | Thrown when a policy denies an action. |
27
- | [ResourceRegistry](./docs/api/appkit/Class.ResourceRegistry.md) | Central registry for tracking plugin resource requirements. Deduplication uses type + resourceKey (machine-stable); alias is for display only. |
28
- | [ServerError](./docs/api/appkit/Class.ServerError.md) | Error thrown when server lifecycle operations fail. Use for server start/stop issues, configuration conflicts, etc. |
29
- | [SupervisorApiAdapter](./docs/api/appkit/Class.SupervisorApiAdapter.md) | Adapter that calls the Databricks AI Gateway Responses API (`/ai-gateway/mlflow/v1/responses`). |
30
- | [TunnelError](./docs/api/appkit/Class.TunnelError.md) | Error thrown when remote tunnel operations fail. Use for tunnel connection issues, message parsing failures, etc. |
31
- | [ValidationError](./docs/api/appkit/Class.ValidationError.md) | Error thrown when input validation fails. Use for invalid parameters, missing required fields, or type mismatches. |
14
+ | Class | Description |
15
+ | ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
16
+ | [AppKitError](./docs/api/appkit/Class.AppKitError.md) | Base error class for all AppKit errors. Provides a consistent structure for error handling across the framework. |
17
+ | [AppKitMcpClient](./docs/api/appkit/Class.AppKitMcpClient.md) | Lightweight MCP client for Databricks-hosted MCP servers. |
18
+ | [AuthenticationError](./docs/api/appkit/Class.AuthenticationError.md) | Error thrown when authentication fails. Use for missing tokens, invalid credentials, or authorization failures. |
19
+ | [ConfigurationError](./docs/api/appkit/Class.ConfigurationError.md) | Error thrown when configuration is missing or invalid. Use for missing environment variables, invalid settings, or setup issues. |
20
+ | [ConnectionError](./docs/api/appkit/Class.ConnectionError.md) | Error thrown when a connection or network operation fails. Use for database pool errors, API failures, timeouts, etc. |
21
+ | [DatabaseValidationError](./docs/api/appkit/Class.DatabaseValidationError.md) | Deliberate validation failure raised by a database mutation hook. Generated routes answer `422` and echo only the issues naming a public column; every other failure raised inside a hook stays an opaque server error. |
22
+ | [DatabricksAdapter](./docs/api/appkit/Class.DatabricksAdapter.md) | Adapter that talks directly to Databricks Model Serving `/invocations` endpoint. |
23
+ | [ExecutionError](./docs/api/appkit/Class.ExecutionError.md) | Error thrown when an operation execution fails. Use for statement failures, canceled operations, or unexpected states. |
24
+ | [InitializationError](./docs/api/appkit/Class.InitializationError.md) | Error thrown when a service or component is not properly initialized. Use when accessing services before they are ready. |
25
+ | [MlflowClient](./docs/api/appkit/Class.MlflowClient.md) | A thin client over the Databricks workspace REST API, owning the host + bearer token so callers (eval-run creation, assessment writes, the judge's serving endpoint) don't each re-derive URLs or re-attach auth. The host is normalized once at construction. |
26
+ | [Plugin](./docs/api/appkit/Class.Plugin.md) | Base abstract class for creating AppKit plugins. |
27
+ | [PolicyDeniedError](./docs/api/appkit/Class.PolicyDeniedError.md) | Thrown when a policy denies an action. |
28
+ | [ResourceRegistry](./docs/api/appkit/Class.ResourceRegistry.md) | Central registry for tracking plugin resource requirements. Deduplication uses type + resourceKey (machine-stable); alias is for display only. |
29
+ | [ServerError](./docs/api/appkit/Class.ServerError.md) | Error thrown when server lifecycle operations fail. Use for server start/stop issues, configuration conflicts, etc. |
30
+ | [SupervisorApiAdapter](./docs/api/appkit/Class.SupervisorApiAdapter.md) | Adapter that calls the Databricks AI Gateway Responses API (`/ai-gateway/mlflow/v1/responses`). |
31
+ | [TunnelError](./docs/api/appkit/Class.TunnelError.md) | Error thrown when remote tunnel operations fail. Use for tunnel connection issues, message parsing failures, etc. |
32
+ | [ValidationError](./docs/api/appkit/Class.ValidationError.md) | Error thrown when input validation fails. Use for invalid parameters, missing required fields, or type mismatches. |
32
33
 
33
34
  ## Interfaces[​](#interfaces "Direct link to Interfaces")
34
35
 
@@ -49,10 +50,13 @@ Documentation merge entry for Typedoc — combines the stable `@databricks/appki
49
50
  | [CustomJudgeSpec](./docs/api/appkit/Interface.CustomJudgeSpec.md) | A custom LLM-judge definition: a prompt template and choice→score mapping. |
50
51
  | [DatabaseCredential](./docs/api/appkit/Interface.DatabaseCredential.md) | Database credentials with OAuth token for Postgres connection |
51
52
  | [DatabaseRegistry](./docs/api/appkit/Interface.DatabaseRegistry.md) | CANONICAL augmentation target. Empty by default; the generated `database.d.ts` augments it via `declare module "@databricks/appkit" { interface DatabaseRegistry { ... } }`. |
53
+ | [DatabaseValidationIssue](./docs/api/appkit/Interface.DatabaseValidationIssue.md) | One rejected field; `path` names public columns, never their values. |
52
54
  | [DatabricksAuth](./docs/api/appkit/Interface.DatabricksAuth.md) | Resolved Databricks host + bearer token for the eval runner's REST calls. |
55
+ | [DatasetRow](./docs/api/appkit/Interface.DatasetRow.md) | One row of a managed evaluation dataset. `inputs` are the kwargs passed to the agent for the turn; `expectations` (when present) is the row's ground truth / guidelines. Mirrors the `{inputs, expectations}` shape of `mlflow.genai` datasets and of the Unity Catalog table backing a managed eval dataset. |
53
56
  | [DiscoveredEval](./docs/api/appkit/Interface.DiscoveredEval.md) | An eval file found under `server/agents/<agent>/evals/`. |
54
57
  | [DriveResult](./docs/api/appkit/Interface.DriveResult.md) | What a driver returns for a single `t.send`. |
55
58
  | [EndpointConfig](./docs/api/appkit/Interface.EndpointConfig.md) | - |
59
+ | [EntityMutationHooks](./docs/api/appkit/Interface.EntityMutationHooks.md) | Mutation lifecycle for one entity. A before hook may return a replacement payload, which is revalidated against the trusted schema before it is persisted. Every hook, the mutation, and any write a hook issues through `ctx.app.database` share one transaction, so a rejection anywhere rolls all of them back. Throw `DatabaseValidationError` to answer a generated route with `422`; any other failure stays an opaque server error. |
56
60
  | [EvalDefinition](./docs/api/appkit/Interface.EvalDefinition.md) | A single eval, default-exported from a `*.eval.ts` file. |
57
61
  | [EvalDriver](./docs/api/appkit/Interface.EvalDriver.md) | Abstraction over how the agent is driven. The HTTP driver posts to a running app's agents endpoint; future drivers (in-process) implement the same shape. |
58
62
  | [EvalResult](./docs/api/appkit/Interface.EvalResult.md) | The outcome of running one eval. |
@@ -63,6 +67,8 @@ Documentation merge entry for Typedoc — combines the stable `@databricks/appki
63
67
  | [FunctionTool](./docs/api/appkit/Interface.FunctionTool.md) | - |
64
68
  | [GenerateDatabaseCredentialRequest](./docs/api/appkit/Interface.GenerateDatabaseCredentialRequest.md) | Request parameters for generating database OAuth credentials |
65
69
  | [GenerationParams](./docs/api/appkit/Interface.GenerationParams.md) | Optional generation parameters forwarded to the OpenAI-compatible serving request body. Names match the serving API wire keys. Only keys that are set are sent — undefined values are omitted so the endpoint applies its own defaults. Ranges are not validated here; the serving endpoint validates. |
70
+ | [HookApp](./docs/api/appkit/Interface.HookApp.md) | The only capability a hook receives: entities bound to its transaction. |
71
+ | [HookContext](./docs/api/appkit/Interface.HookContext.md) | Which entity is being mutated, and the surface a hook may write through. |
66
72
  | [HostedSupervisorTool](./docs/api/appkit/Interface.HostedSupervisorTool.md) | Tagged record returned by every [supervisorTools](./docs/api/appkit/Variable.supervisorTools.md) factory. The `__kind` discriminator lets the agents plugin (and standalone `runAgent`) classify these tools without a structural match against the wire format — keeps the SA wire shape free to evolve and avoids namespace collisions with MCP hosted tools (which use `type: "genie-space"` hyphenated, vs SA's `type: "genie_space"` underscored). |
67
73
  | [HttpDriverOptions](./docs/api/appkit/Interface.HttpDriverOptions.md) | - |
68
74
  | [IAiSearchConfig](./docs/api/appkit/Interface.IAiSearchConfig.md) | Base configuration interface for AppKit plugins |
@@ -84,6 +90,8 @@ Documentation merge entry for Typedoc — combines the stable `@databricks/appki
84
90
  | [PluginToolkitProvider](./docs/api/appkit/Interface.PluginToolkitProvider.md) | Minimum shape every entry in the [Plugins](./docs/api/appkit/TypeAlias.Plugins.md) map must expose. Core plugins (analytics, files, genie, lakebase) implement this directly via their `.toolkit()` method. The agents plugin and standalone `runAgent` synthesize this shape for any registered plugin that doesn't implement `.toolkit()` directly (falling back to `getAgentTools()` walking). |
85
91
  | [PostResult](./docs/api/appkit/Interface.PostResult.md) | Structured result for a best-effort POST that must not throw. |
86
92
  | [PromptContext](./docs/api/appkit/Interface.PromptContext.md) | Context passed to `baseSystemPrompt` callbacks. |
93
+ | [ReadEvalDatasetOptions](./docs/api/appkit/Interface.ReadEvalDatasetOptions.md) | - |
94
+ | [ReadSerializerContext](./docs/api/appkit/Interface.ReadSerializerContext.md) | Which entity and generated operation produced the row being shaped. |
87
95
  | [RegisteredAgent](./docs/api/appkit/Interface.RegisteredAgent.md) | - |
88
96
  | [ReportOutcome](./docs/api/appkit/Interface.ReportOutcome.md) | - |
89
97
  | [RequestedClaims](./docs/api/appkit/Interface.RequestedClaims.md) | Optional claims for fine-grained Unity Catalog table permissions When specified, the returned token will be scoped to only the requested tables |
@@ -122,35 +130,41 @@ Documentation merge entry for Typedoc — combines the stable `@databricks/appki
122
130
 
123
131
  ## Type Aliases[​](#type-aliases "Direct link to Type Aliases")
124
132
 
125
- | Type Alias | Description |
126
- | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
127
- | [AgentEvent](./docs/api/appkit/TypeAlias.AgentEvent.md) | - |
128
- | [AgentTool](./docs/api/appkit/TypeAlias.AgentTool.md) | Any tool an agent can invoke: inline function tools (`tool()`), hosted MCP tools (`mcpServer()` / raw hosted), toolkit references from plugins (`analytics().toolkit()`), or adapter-hosted Supervisor-API tools (`supervisorTools.*`). |
129
- | [AgentTools](./docs/api/appkit/TypeAlias.AgentTools.md) | Per-agent tool record. String keys map to inline tools, toolkit entries, hosted tools, etc. |
130
- | [AgentToolsFn](./docs/api/appkit/TypeAlias.AgentToolsFn.md) | Function form of `AgentDefinition.tools`. Receives the typed [Plugins](./docs/api/appkit/TypeAlias.Plugins.md) map and returns a tool record. Invoked exactly once at setup (or once per `runAgent` call in standalone mode); the result is cached as the agent's resolved tool record. |
131
- | [BaseSystemPromptOption](./docs/api/appkit/TypeAlias.BaseSystemPromptOption.md) | - |
132
- | [ConfigSchema](./docs/api/appkit/TypeAlias.ConfigSchema.md) | Configuration schema definition for plugin config. Re-exported from the standard JSON Schema Draft 7 types. |
133
- | [DatabaseExports](./docs/api/appkit/TypeAlias.DatabaseExports.md) | Typed database API published by the plugin. |
134
- | [EvalProgress](./docs/api/appkit/TypeAlias.EvalProgress.md) | - |
135
- | [ExecutionResult](./docs/api/appkit/TypeAlias.ExecutionResult.md) | Discriminated union for plugin execution results. |
136
- | [FileAction](./docs/api/appkit/TypeAlias.FileAction.md) | Every action the files plugin can perform. |
137
- | [FilePolicy](./docs/api/appkit/TypeAlias.FilePolicy.md) | A policy function that decides whether `user` may perform `action` on `resource`. Return `true` to allow, `false` to deny. |
138
- | [HostedTool](./docs/api/appkit/TypeAlias.HostedTool.md) | - |
139
- | [IAppRouter](./docs/api/appkit/TypeAlias.IAppRouter.md) | Express router type for plugin route registration |
140
- | [IDatabaseConfig](./docs/api/appkit/TypeAlias.IDatabaseConfig.md) | Configuration for one schema-bound DatabasePlugin instance. |
141
- | [JobsExport](./docs/api/appkit/TypeAlias.JobsExport.md) | Public API shape of the jobs plugin. Callable to select a job by key. |
142
- | [Matcher](./docs/api/appkit/TypeAlias.Matcher.md) | A deterministic matcher: inspects a string value and returns a result. |
143
- | [PluginData](./docs/api/appkit/TypeAlias.PluginData.md) | Tuple of plugin class, config, and name. Created by `toPlugin()` and passed to `createApp()`. |
144
- | [Plugins](./docs/api/appkit/TypeAlias.Plugins.md) | Plugin map passed to the function form of [AgentDefinition.tools](./docs/api/appkit/Interface.AgentDefinition.md#tools). Each entry exposes a `.toolkit(opts?)` method that returns a record of [ToolkitEntry](./docs/api/appkit/Interface.ToolkitEntry.md) markers ready to be spread into a tool record. |
145
- | [ResolvedToolEntry](./docs/api/appkit/TypeAlias.ResolvedToolEntry.md) | Internal tool-index entry after a tool record has been resolved to a dispatchable form. |
146
- | [ResourceFieldEntry](./docs/api/appkit/TypeAlias.ResourceFieldEntry.md) | - |
147
- | [ResourcePermission](./docs/api/appkit/TypeAlias.ResourcePermission.md) | Union of all possible permission levels across all resource types. |
148
- | [SearchFilters](./docs/api/appkit/TypeAlias.SearchFilters.md) | - |
149
- | [ServingFactory](./docs/api/appkit/TypeAlias.ServingFactory.md) | Factory function returned by `AppKit.serving`. |
150
- | [Severity](./docs/api/appkit/TypeAlias.Severity.md) | Whether an assertion fails the eval (`gate`) or is tracked only (`soft`). |
151
- | [SupervisorTool](./docs/api/appkit/TypeAlias.SupervisorTool.md) | Tools supported by the Databricks AI Gateway Responses API. The shapes match the wire format the endpoint expects, so the adapter passes the array straight into the request body. |
152
- | [ToolRegistry](./docs/api/appkit/TypeAlias.ToolRegistry.md) | - |
153
- | [ToPlugin](./docs/api/appkit/TypeAlias.ToPlugin.md) | Factory function type returned by `toPlugin()`. Accepts optional config and returns a PluginData tuple. |
133
+ | Type Alias | Description |
134
+ | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
135
+ | [AgentEvent](./docs/api/appkit/TypeAlias.AgentEvent.md) | - |
136
+ | [AgentTool](./docs/api/appkit/TypeAlias.AgentTool.md) | Any tool an agent can invoke: inline function tools (`tool()`), hosted MCP tools (`mcpServer()` / raw hosted), toolkit references from plugins (`analytics().toolkit()`), or adapter-hosted Supervisor-API tools (`supervisorTools.*`). |
137
+ | [AgentTools](./docs/api/appkit/TypeAlias.AgentTools.md) | Per-agent tool record. String keys map to inline tools, toolkit entries, hosted tools, etc. |
138
+ | [AgentToolsFn](./docs/api/appkit/TypeAlias.AgentToolsFn.md) | Function form of `AgentDefinition.tools`. Receives the typed [Plugins](./docs/api/appkit/TypeAlias.Plugins.md) map and returns a tool record. Invoked exactly once at setup (or once per `runAgent` call in standalone mode); the result is cached as the agent's resolved tool record. |
139
+ | [BaseSystemPromptOption](./docs/api/appkit/TypeAlias.BaseSystemPromptOption.md) | - |
140
+ | [ConfigSchema](./docs/api/appkit/TypeAlias.ConfigSchema.md) | Configuration schema definition for plugin config. Re-exported from the standard JSON Schema Draft 7 types. |
141
+ | [DatabaseApiConfig](./docs/api/appkit/TypeAlias.DatabaseApiConfig.md) | Full generated CRUD for every declared table by default. Set false to disable all generated routes, or use an object to restrict tables and writes. Keyed routes require a public primary key; upsert stays programmatic. Route names must start with a letter, contain only letters, digits, `_`, or `-`, be at most 64 characters, and be unique ignoring case. Invalid names fail setup; exclude internal tables with `api.tables` or use `api: false`. |
142
+ | [DatabaseApiWriteOperation](./docs/api/appkit/TypeAlias.DatabaseApiWriteOperation.md) | Generated HTTP write operations. |
143
+ | [DatabaseApiWritesConfig](./docs/api/appkit/TypeAlias.DatabaseApiWritesConfig.md) | All writes by default; false keeps reads only, and an object narrows writes. |
144
+ | [DatabaseExports](./docs/api/appkit/TypeAlias.DatabaseExports.md) | Typed database API published by the plugin. |
145
+ | [EntityHooks](./docs/api/appkit/TypeAlias.EntityHooks.md) | Response shaping and mutation lifecycle declared for one table. |
146
+ | [EvalProgress](./docs/api/appkit/TypeAlias.EvalProgress.md) | - |
147
+ | [ExecutionResult](./docs/api/appkit/TypeAlias.ExecutionResult.md) | Discriminated union for plugin execution results. |
148
+ | [FileAction](./docs/api/appkit/TypeAlias.FileAction.md) | Every action the files plugin can perform. |
149
+ | [FilePolicy](./docs/api/appkit/TypeAlias.FilePolicy.md) | A policy function that decides whether `user` may perform `action` on `resource`. Return `true` to allow, `false` to deny. |
150
+ | [HostedTool](./docs/api/appkit/TypeAlias.HostedTool.md) | - |
151
+ | [IAppRouter](./docs/api/appkit/TypeAlias.IAppRouter.md) | Express router type for plugin route registration |
152
+ | [IDatabaseConfig](./docs/api/appkit/TypeAlias.IDatabaseConfig.md) | Configuration for one schema-bound DatabasePlugin instance. |
153
+ | [JobsExport](./docs/api/appkit/TypeAlias.JobsExport.md) | Public API shape of the jobs plugin. Callable to select a job by key. |
154
+ | [Matcher](./docs/api/appkit/TypeAlias.Matcher.md) | A deterministic matcher: inspects a string value and returns a result. |
155
+ | [PluginData](./docs/api/appkit/TypeAlias.PluginData.md) | Tuple of plugin class, config, and name. Created by `toPlugin()` and passed to `createApp()`. |
156
+ | [Plugins](./docs/api/appkit/TypeAlias.Plugins.md) | Plugin map passed to the function form of [AgentDefinition.tools](./docs/api/appkit/Interface.AgentDefinition.md#tools). Each entry exposes a `.toolkit(opts?)` method that returns a record of [ToolkitEntry](./docs/api/appkit/Interface.ToolkitEntry.md) markers ready to be spread into a tool record. |
157
+ | [ReadSerializer](./docs/api/appkit/TypeAlias.ReadSerializer.md) | Shape one already private-safe row before it reaches the wire. A `Promise` is not assignable to the return type, so an async callback fails to compile: serializers run inside the response path and must not add latency there. |
158
+ | [ResolvedToolEntry](./docs/api/appkit/TypeAlias.ResolvedToolEntry.md) | Internal tool-index entry after a tool record has been resolved to a dispatchable form. |
159
+ | [ResourceFieldEntry](./docs/api/appkit/TypeAlias.ResourceFieldEntry.md) | - |
160
+ | [ResourcePermission](./docs/api/appkit/TypeAlias.ResourcePermission.md) | Union of all possible permission levels across all resource types. |
161
+ | [SearchFilters](./docs/api/appkit/TypeAlias.SearchFilters.md) | - |
162
+ | [ServingFactory](./docs/api/appkit/TypeAlias.ServingFactory.md) | Factory function returned by `AppKit.serving`. |
163
+ | [Severity](./docs/api/appkit/TypeAlias.Severity.md) | Whether an assertion fails the eval (`gate`) or is tracked only (`soft`). |
164
+ | [SupervisorTool](./docs/api/appkit/TypeAlias.SupervisorTool.md) | Tools supported by the Databricks AI Gateway Responses API. The shapes match the wire format the endpoint expects, so the adapter passes the array straight into the request body. |
165
+ | [ToolRegistry](./docs/api/appkit/TypeAlias.ToolRegistry.md) | - |
166
+ | [ToPlugin](./docs/api/appkit/TypeAlias.ToPlugin.md) | Factory function type returned by `toPlugin()`. Accepts optional config and returns a PluginData tuple. |
167
+ | [TransactionClient](./docs/api/appkit/TypeAlias.TransactionClient.md) | Entity and SQL capabilities bound to one transaction. |
154
168
 
155
169
  ## Variables[​](#variables "Direct link to Variables")
156
170
 
@@ -166,75 +180,77 @@ Documentation merge entry for Typedoc — combines the stable `@databricks/appki
166
180
 
167
181
  ## Functions[​](#functions "Direct link to Functions")
168
182
 
169
- | Function | Description |
170
- | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
171
- | [agentIdFromMarkdownPath](./docs/api/appkit/Function.agentIdFromMarkdownPath.md) | Derives the logical agent id from a markdown path. When the file is named `agent.md`, the id is the parent directory name (folder-based layout); otherwise the id is the file stem (e.g. legacy single-file paths). |
172
- | [appKitServingTypesPlugin](./docs/api/appkit/Function.appKitServingTypesPlugin.md) | Vite plugin to generate TypeScript types for AppKit serving endpoints. Fetches OpenAPI schemas from Databricks and generates a .d.ts with ServingEndpointRegistry module augmentation. |
173
- | [appKitTypesPlugin](./docs/api/appkit/Function.appKitTypesPlugin.md) | Vite plugin to generate types for AppKit queries. Calls generateFromEntryPoint under the hood. |
174
- | [bigid](./docs/api/appkit/Function.bigid.md) | - |
175
- | [bigint](./docs/api/appkit/Function.bigint.md) | - |
176
- | [boolean](./docs/api/appkit/Function.boolean.md) | - |
177
- | [buildAssessments](./docs/api/appkit/Function.buildAssessments.md) | - |
178
- | [configureJudge](./docs/api/appkit/Function.configureJudge.md) | Configure the judge once. Sets the OpenAI-compatible client env autoevals reads and the default judge model. No-op-safe: on failure, judging stays disabled and [isJudgeConfigured](./docs/api/appkit/Function.isJudgeConfigured.md) returns false. |
179
- | [createAgent](./docs/api/appkit/Function.createAgent.md) | Pure factory for agent definitions: cycle-detects the sub-agent graph and returns the same object, stamped with a non-enumerable AGENT\_BRAND so discovery recognizes it. Safe at module top-level; no adapter is built. Don't `Object.freeze` the definition before passing it in — the brand is written onto the argument. |
180
- | [createApp](./docs/api/appkit/Function.createApp.md) | Bootstraps AppKit with the provided configuration. |
181
- | [createHttpDriver](./docs/api/appkit/Function.createHttpDriver.md) | Drives an agent by POSTing to a running app's chat endpoint and parsing the SSE response. Keeps the thread id across `send`s so multi-turn evals share a conversation. Agent/stream errors surface as `succeeded: false` rather than throwing, so `t.succeeded()` can assert on them. |
182
- | [createLakebasePool](./docs/api/appkit/Function.createLakebasePool.md) | Create a Lakebase pool with appkit's logger integration. Telemetry automatically uses appkit's OpenTelemetry configuration via global registry. |
183
- | [createLakebasePoolManager](./docs/api/appkit/Function.createLakebasePoolManager.md) | Create a pool manager that maintains per-key Lakebase connection pools. |
184
- | [createWorkspaceClient](./docs/api/appkit/Function.createWorkspaceClient.md) | Construct an AppKit workspace client. |
185
- | [database](./docs/api/appkit/Function.database.md) | Create a typed database plugin registration for a finalized schema. |
186
- | [defineEval](./docs/api/appkit/Function.defineEval.md) | Define an agent eval. Default-export the result from a `server/agents/<id>/evals/*.eval.ts` file. |
187
- | [defineManifest](./docs/api/appkit/Function.defineManifest.md) | Validates a raw manifest (typically a `manifest.json` import) against the canonical Zod schema and returns it as a strict [PluginManifest](./docs/api/appkit/Interface.PluginManifest.md). |
188
- | [defineSchema](./docs/api/appkit/Function.defineSchema.md) | Compile one declared schema. The returned type keeps the table names the builder returned, so `crudRoutes` and `hooks` can name only real tables. |
189
- | [defineTool](./docs/api/appkit/Function.defineTool.md) | Defines a single tool entry for a plugin's internal registry. |
190
- | [discoverEvalFiles](./docs/api/appkit/Function.discoverEvalFiles.md) | Discover evals under `<rootDir>/server/agents/<agent>/evals/` — co-located with each agent's `agent.{md,ts}` (same folder-per-agent layout the agents plugin discovers). The agent id is the folder name; the eval id is the file path relative to that evals dir with `.eval.ts` stripped. Sorted + stable. |
191
- | [enumColumn](./docs/api/appkit/Function.enumColumn.md) | - |
192
- | [equals](./docs/api/appkit/Function.equals.md) | Passes when the value equals `expected` exactly. |
193
- | [evalGlyph](./docs/api/appkit/Function.evalGlyph.md) | Status glyph for a single eval result. |
194
- | [executeFromRegistry](./docs/api/appkit/Function.executeFromRegistry.md) | Validates tool-call arguments against the entry's schema and invokes its handler. On validation failure, returns an LLM-friendly error string (matching the behavior of `tool()`) rather than throwing, so the model can self-correct on its next turn. |
195
- | [extractServingEndpoints](./docs/api/appkit/Function.extractServingEndpoints.md) | Extract serving endpoint config from a server file by AST-parsing it. Looks for `serving({ endpoints: { alias: { env: "..." }, ... } })` calls and extracts the endpoint alias names and their environment variable mappings. |
196
- | [findServerFile](./docs/api/appkit/Function.findServerFile.md) | Find the server entry file by checking candidate paths in order. |
197
- | [fk](./docs/api/appkit/Function.fk.md) | Declare foreign-key to another column. |
198
- | [formatEvalDetail](./docs/api/appkit/Function.formatEvalDetail.md) | Indented detail lines for a failing eval (error + failing assertions). |
199
- | [formatEvalHeadline](./docs/api/appkit/Function.formatEvalHeadline.md) | The one-line header for a single eval result (no failure detail). |
200
- | [formatEvalResults](./docs/api/appkit/Function.formatEvalResults.md) | Render all results as a human-readable console report (non-streaming). |
201
- | [formatSummaryLine](./docs/api/appkit/Function.formatSummaryLine.md) | The final PASS/FAIL summary line. |
202
- | [fromSupervisorApi](./docs/api/appkit/Function.fromSupervisorApi.md) | Creates an [AgentAdapter](./docs/api/appkit/Interface.AgentAdapter.md) backed by the Databricks AI Gateway Responses API (`/ai-gateway/mlflow/v1/responses`). |
203
- | [functionToolToDefinition](./docs/api/appkit/Function.functionToolToDefinition.md) | - |
204
- | [generateDatabaseCredential](./docs/api/appkit/Function.generateDatabaseCredential.md) | Generate OAuth credentials for Postgres database connection using the proper Postgres API. |
205
- | [getExecutionContext](./docs/api/appkit/Function.getExecutionContext.md) | Get the current execution context. |
206
- | [getLakebaseOrmConfig](./docs/api/appkit/Function.getLakebaseOrmConfig.md) | Get Lakebase connection configuration for ORMs that don't accept pg.Pool directly. |
207
- | [getLakebasePgConfig](./docs/api/appkit/Function.getLakebasePgConfig.md) | Get Lakebase connection configuration for PostgreSQL clients. |
208
- | [getPluginManifest](./docs/api/appkit/Function.getPluginManifest.md) | Loads and validates the manifest from a plugin constructor. Normalizes string type/permission to strict ResourceType/ResourcePermission. |
209
- | [getResourceRequirements](./docs/api/appkit/Function.getResourceRequirements.md) | Gets the resource requirements from a plugin's manifest. |
210
- | [getUsernameWithApiLookup](./docs/api/appkit/Function.getUsernameWithApiLookup.md) | Resolves the PostgreSQL username for a Lakebase connection. |
211
- | [getWorkspaceClient](./docs/api/appkit/Function.getWorkspaceClient.md) | Get workspace client from config or SDK default auth chain |
212
- | [id](./docs/api/appkit/Function.id.md) | - |
213
- | [includes](./docs/api/appkit/Function.includes.md) | Passes when the value contains `substring`. |
214
- | [integer](./docs/api/appkit/Function.integer.md) | - |
215
- | [isFunctionTool](./docs/api/appkit/Function.isFunctionTool.md) | - |
216
- | [isHostedTool](./docs/api/appkit/Function.isHostedTool.md) | - |
217
- | [isJudgeConfigured](./docs/api/appkit/Function.isJudgeConfigured.md) | - |
218
- | [isSQLTypeMarker](./docs/api/appkit/Function.isSQLTypeMarker.md) | Type guard to check if a value is a SQL type marker |
219
- | [isSupervisorTool](./docs/api/appkit/Function.isSupervisorTool.md) | Type guard for [HostedSupervisorTool](./docs/api/appkit/Interface.HostedSupervisorTool.md). Used by the agents plugin (`buildToolIndex`) and standalone `runAgent` (`classifyTool`) to route supervisor-hosted tools to the extensions payload rather than the adapter's `tools` array. |
220
- | [isToolkitEntry](./docs/api/appkit/Function.isToolkitEntry.md) | Type guard for `ToolkitEntry` — used by the agents plugin to differentiate toolkit references from inline tools in a mixed `tools` record. |
221
- | [jsonb](./docs/api/appkit/Function.jsonb.md) | - |
222
- | [loadAgentFromFile](./docs/api/appkit/Function.loadAgentFromFile.md) | Loads a single markdown agent file and resolves its frontmatter against registered plugin toolkits + ambient tool library. |
223
- | [loadAgentsFromDir](./docs/api/appkit/Function.loadAgentsFromDir.md) | Scans a directory for one subdirectory per agent, each containing `agent.md` (frontmatter + body). Produces an `AgentDefinition` record keyed by agent id (folder name). Throws on frontmatter errors or unresolved references. Returns an empty map if the directory does not exist. |
224
- | [matches](./docs/api/appkit/Function.matches.md) | Passes when the value matches `pattern`. |
225
- | [mcpServer](./docs/api/appkit/Function.mcpServer.md) | Factory for declaring a custom MCP server tool. |
226
- | [normalizeHost](./docs/api/appkit/Function.normalizeHost.md) | Ensure the host has a scheme (Databricks env often lacks `https://`). |
227
- | [parseTextToolCalls](./docs/api/appkit/Function.parseTextToolCalls.md) | Parses text-based tool calls from model output. |
228
- | [reportToMlflow](./docs/api/appkit/Function.reportToMlflow.md) | Write one pass/fail assessment per eval result to the Databricks MLflow REST API. Never throws — failures are collected so the run still reports. |
229
- | [resolveDatabricksAuth](./docs/api/appkit/Function.resolveDatabricksAuth.md) | - |
230
- | [resolveHostedTools](./docs/api/appkit/Function.resolveHostedTools.md) | - |
231
- | [runAgent](./docs/api/appkit/Function.runAgent.md) | Standalone agent execution without `createApp`. Resolves the adapter, binds inline tools, and drives the adapter's `run()` loop to completion. |
232
- | [runEval](./docs/api/appkit/Function.runEval.md) | Run a single eval against a driver. Never throws for assertion or agent failures — those become a non-passing [EvalResult](./docs/api/appkit/Interface.EvalResult.md). Only a malformed eval definition surfaces as `result.error`. |
233
- | [runEvalsInDir](./docs/api/appkit/Function.runEvalsInDir.md) | Discover, load, and run every eval under each agent's `evals/` dir, driving the agents on a running app. Never throws for an individual eval — load/run failures become non-passing [EvalResult](./docs/api/appkit/Interface.EvalResult.md)s. |
234
- | [summarize](./docs/api/appkit/Function.summarize.md) | - |
235
- | [text](./docs/api/appkit/Function.text.md) | - |
236
- | [timestamp](./docs/api/appkit/Function.timestamp.md) | - |
237
- | [tool](./docs/api/appkit/Function.tool.md) | Factory for defining function tools with Zod schemas. |
238
- | [toolsFromRegistry](./docs/api/appkit/Function.toolsFromRegistry.md) | Produces the `AgentToolDefinition[]` a ToolProvider exposes to the LLM, deriving `parameters` JSON Schema from each entry's Zod schema. |
239
- | [uuid](./docs/api/appkit/Function.uuid.md) | - |
240
- | [varchar](./docs/api/appkit/Function.varchar.md) | - |
183
+ | Function | Description |
184
+ | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
185
+ | [agentIdFromMarkdownPath](./docs/api/appkit/Function.agentIdFromMarkdownPath.md) | Derives the logical agent id from a markdown path. When the file is named `agent.md`, the id is the parent directory name (folder-based layout); otherwise the id is the file stem (e.g. legacy single-file paths). |
186
+ | [appKitServingTypesPlugin](./docs/api/appkit/Function.appKitServingTypesPlugin.md) | Vite plugin to generate TypeScript types for AppKit serving endpoints. Fetches OpenAPI schemas from Databricks and generates a .d.ts with ServingEndpointRegistry module augmentation. |
187
+ | [appKitTypesPlugin](./docs/api/appkit/Function.appKitTypesPlugin.md) | Vite plugin to generate types for AppKit queries. Calls generateFromEntryPoint under the hood. |
188
+ | [bigid](./docs/api/appkit/Function.bigid.md) | - |
189
+ | [bigint](./docs/api/appkit/Function.bigint.md) | - |
190
+ | [boolean](./docs/api/appkit/Function.boolean.md) | - |
191
+ | [buildAssessments](./docs/api/appkit/Function.buildAssessments.md) | - |
192
+ | [configureJudge](./docs/api/appkit/Function.configureJudge.md) | Configure the judge once. Sets the OpenAI-compatible client env autoevals reads and the default judge model. No-op-safe: on failure, judging stays disabled and [isJudgeConfigured](./docs/api/appkit/Function.isJudgeConfigured.md) returns false. |
193
+ | [createAgent](./docs/api/appkit/Function.createAgent.md) | Pure factory for agent definitions: cycle-detects the sub-agent graph and returns the same object, stamped with a non-enumerable AGENT\_BRAND so discovery recognizes it. Safe at module top-level; no adapter is built. Don't `Object.freeze` the definition before passing it in — the brand is written onto the argument. |
194
+ | [createApp](./docs/api/appkit/Function.createApp.md) | Bootstraps AppKit with the provided configuration. |
195
+ | [createHttpDriver](./docs/api/appkit/Function.createHttpDriver.md) | Drives an agent by POSTing to a running app's chat endpoint and parsing the SSE response. Keeps the thread id across `send`s so multi-turn evals share a conversation. Agent/stream errors surface as `succeeded: false` rather than throwing, so `t.succeeded()` can assert on them. |
196
+ | [createLakebasePool](./docs/api/appkit/Function.createLakebasePool.md) | Create a Lakebase pool with appkit's logger integration. Telemetry automatically uses appkit's OpenTelemetry configuration via global registry. |
197
+ | [createLakebasePoolManager](./docs/api/appkit/Function.createLakebasePoolManager.md) | Create a pool manager that maintains per-key Lakebase connection pools. |
198
+ | [createWorkspaceClient](./docs/api/appkit/Function.createWorkspaceClient.md) | Construct an AppKit workspace client. |
199
+ | [database](./docs/api/appkit/Function.database.md) | Create a typed database plugin registration for a finalized schema. |
200
+ | [defineEval](./docs/api/appkit/Function.defineEval.md) | Define an agent eval. Default-export the result from a `server/agents/<id>/evals/*.eval.ts` file. |
201
+ | [defineManifest](./docs/api/appkit/Function.defineManifest.md) | Validates a raw manifest (typically a `manifest.json` import) against the canonical Zod schema and returns it as a strict [PluginManifest](./docs/api/appkit/Interface.PluginManifest.md). |
202
+ | [defineSchema](./docs/api/appkit/Function.defineSchema.md) | Compile one declared schema. The returned type keeps the table names the builder returned, so `api.tables` and `hooks` can name only real tables. |
203
+ | [defineTool](./docs/api/appkit/Function.defineTool.md) | Defines a single tool entry for a plugin's internal registry. |
204
+ | [discoverEvalFiles](./docs/api/appkit/Function.discoverEvalFiles.md) | Discover evals under `<rootDir>/server/agents/<agent>/evals/` — co-located with each agent's `agent.{md,ts}` (same folder-per-agent layout the agents plugin discovers). The agent id is the folder name; the eval id is the file path relative to that evals dir with `.eval.ts` stripped. Sorted + stable. |
205
+ | [enumColumn](./docs/api/appkit/Function.enumColumn.md) | - |
206
+ | [equals](./docs/api/appkit/Function.equals.md) | Passes when the value equals `expected` exactly. |
207
+ | [evalGlyph](./docs/api/appkit/Function.evalGlyph.md) | Status glyph for a single eval result. |
208
+ | [executeFromRegistry](./docs/api/appkit/Function.executeFromRegistry.md) | Validates tool-call arguments against the entry's schema and invokes its handler. On validation failure, returns an LLM-friendly error string (matching the behavior of `tool()`) rather than throwing, so the model can self-correct on its next turn. |
209
+ | [extractServingEndpoints](./docs/api/appkit/Function.extractServingEndpoints.md) | Extract serving endpoint config from a server file by AST-parsing it. Looks for `serving({ endpoints: { alias: { env: "..." }, ... } })` calls and extracts the endpoint alias names and their environment variable mappings. |
210
+ | [findServerFile](./docs/api/appkit/Function.findServerFile.md) | Find the server entry file by checking candidate paths in order. |
211
+ | [fk](./docs/api/appkit/Function.fk.md) | Declare foreign-key to another column. |
212
+ | [formatEvalDetail](./docs/api/appkit/Function.formatEvalDetail.md) | Indented detail lines for a failing eval (error + failing assertions). |
213
+ | [formatEvalHeadline](./docs/api/appkit/Function.formatEvalHeadline.md) | The one-line header for a single eval result (no failure detail). |
214
+ | [formatEvalResults](./docs/api/appkit/Function.formatEvalResults.md) | Render all results as a human-readable console report (non-streaming). |
215
+ | [formatSummaryLine](./docs/api/appkit/Function.formatSummaryLine.md) | The final PASS/FAIL summary line. |
216
+ | [fromSupervisorApi](./docs/api/appkit/Function.fromSupervisorApi.md) | Creates an [AgentAdapter](./docs/api/appkit/Interface.AgentAdapter.md) backed by the Databricks AI Gateway Responses API (`/ai-gateway/mlflow/v1/responses`). |
217
+ | [functionToolToDefinition](./docs/api/appkit/Function.functionToolToDefinition.md) | - |
218
+ | [generateDatabaseCredential](./docs/api/appkit/Function.generateDatabaseCredential.md) | Generate OAuth credentials for Postgres database connection using the proper Postgres API. |
219
+ | [getExecutionContext](./docs/api/appkit/Function.getExecutionContext.md) | Get the current execution context. |
220
+ | [getLakebaseOrmConfig](./docs/api/appkit/Function.getLakebaseOrmConfig.md) | Get Lakebase connection configuration for ORMs that don't accept pg.Pool directly. |
221
+ | [getLakebasePgConfig](./docs/api/appkit/Function.getLakebasePgConfig.md) | Get Lakebase connection configuration for PostgreSQL clients. |
222
+ | [getPluginManifest](./docs/api/appkit/Function.getPluginManifest.md) | Loads and validates the manifest from a plugin constructor. Normalizes string type/permission to strict ResourceType/ResourcePermission. |
223
+ | [getResourceRequirements](./docs/api/appkit/Function.getResourceRequirements.md) | Gets the resource requirements from a plugin's manifest. |
224
+ | [getUsernameWithApiLookup](./docs/api/appkit/Function.getUsernameWithApiLookup.md) | Resolves the PostgreSQL username for a Lakebase connection. |
225
+ | [getWorkspaceClient](./docs/api/appkit/Function.getWorkspaceClient.md) | Get workspace client from config or SDK default auth chain |
226
+ | [id](./docs/api/appkit/Function.id.md) | - |
227
+ | [includes](./docs/api/appkit/Function.includes.md) | Passes when the value contains `substring`. |
228
+ | [integer](./docs/api/appkit/Function.integer.md) | - |
229
+ | [isFunctionTool](./docs/api/appkit/Function.isFunctionTool.md) | - |
230
+ | [isHostedTool](./docs/api/appkit/Function.isHostedTool.md) | - |
231
+ | [isJudgeConfigured](./docs/api/appkit/Function.isJudgeConfigured.md) | - |
232
+ | [isSQLTypeMarker](./docs/api/appkit/Function.isSQLTypeMarker.md) | Type guard to check if a value is a SQL type marker |
233
+ | [isSupervisorTool](./docs/api/appkit/Function.isSupervisorTool.md) | Type guard for [HostedSupervisorTool](./docs/api/appkit/Interface.HostedSupervisorTool.md). Used by the agents plugin (`buildToolIndex`) and standalone `runAgent` (`classifyTool`) to route supervisor-hosted tools to the extensions payload rather than the adapter's `tools` array. |
234
+ | [isToolkitEntry](./docs/api/appkit/Function.isToolkitEntry.md) | Type guard for `ToolkitEntry` — used by the agents plugin to differentiate toolkit references from inline tools in a mixed `tools` record. |
235
+ | [jsonb](./docs/api/appkit/Function.jsonb.md) | - |
236
+ | [loadAgentFromFile](./docs/api/appkit/Function.loadAgentFromFile.md) | Loads a single markdown agent file and resolves its frontmatter against registered plugin toolkits + ambient tool library. |
237
+ | [loadAgentsFromDir](./docs/api/appkit/Function.loadAgentsFromDir.md) | Scans a directory for one subdirectory per agent, each containing `agent.md` (frontmatter + body). Produces an `AgentDefinition` record keyed by agent id (folder name). Throws on frontmatter errors or unresolved references. Returns an empty map if the directory does not exist. |
238
+ | [matches](./docs/api/appkit/Function.matches.md) | Passes when the value matches `pattern`. |
239
+ | [mcpServer](./docs/api/appkit/Function.mcpServer.md) | Factory for declaring a custom MCP server tool. |
240
+ | [normalizeHost](./docs/api/appkit/Function.normalizeHost.md) | Ensure the host has a scheme (Databricks env often lacks `https://`). |
241
+ | [parseTextToolCalls](./docs/api/appkit/Function.parseTextToolCalls.md) | Parses text-based tool calls from model output. |
242
+ | [readEvalDataset](./docs/api/appkit/Function.readEvalDataset.md) | Read a Databricks managed evaluation dataset (a Unity Catalog table with `inputs`/`expectations` columns) into rows, over the public SQL Statement Execution API. Reuses SQLWarehouseConnector for submit/poll/transform — its result transform already JSON-parses string columns into objects, so `inputs`/`expectations` come back as records whether the table stores them as JSON strings or structs. |
243
+ | [reportToMlflow](./docs/api/appkit/Function.reportToMlflow.md) | Write one pass/fail assessment per eval result to the Databricks MLflow REST API. Never throws — failures are collected so the run still reports. |
244
+ | [resolveDatabricksAuth](./docs/api/appkit/Function.resolveDatabricksAuth.md) | - |
245
+ | [resolveHostedTools](./docs/api/appkit/Function.resolveHostedTools.md) | - |
246
+ | [resolveWorkspaceClient](./docs/api/appkit/Function.resolveWorkspaceClient.md) | Construct a Databricks `WorkspaceClient` for the eval runner — the object the SDK-backed connectors (e.g. `SQLWarehouseConnector`) take. An explicit host+token builds a PAT client; otherwise the profile (or ambient config) is used and the SDK resolves credentials, minting OAuth as needed. Returns `undefined` if construction throws (missing/invalid config). |
247
+ | [runAgent](./docs/api/appkit/Function.runAgent.md) | Standalone agent execution without `createApp`. Resolves the adapter, binds inline tools, and drives the adapter's `run()` loop to completion. |
248
+ | [runEval](./docs/api/appkit/Function.runEval.md) | Run a single eval against a driver. Never throws for assertion or agent failures — those become a non-passing [EvalResult](./docs/api/appkit/Interface.EvalResult.md). Only a malformed eval definition surfaces as `result.error`. |
249
+ | [runEvalsInDir](./docs/api/appkit/Function.runEvalsInDir.md) | Discover, load, and run every eval under each agent's `evals/` dir, driving the agents on a running app. Never throws for an individual eval — load/run failures become non-passing [EvalResult](./docs/api/appkit/Interface.EvalResult.md)s. |
250
+ | [summarize](./docs/api/appkit/Function.summarize.md) | - |
251
+ | [text](./docs/api/appkit/Function.text.md) | - |
252
+ | [timestamp](./docs/api/appkit/Function.timestamp.md) | - |
253
+ | [tool](./docs/api/appkit/Function.tool.md) | Factory for defining function tools with Zod schemas. |
254
+ | [toolsFromRegistry](./docs/api/appkit/Function.toolsFromRegistry.md) | Produces the `AgentToolDefinition[]` a ToolProvider exposes to the LLM, deriving `parameters` JSON Schema from each entry's Zod schema. |
255
+ | [uuid](./docs/api/appkit/Function.uuid.md) | - |
256
+ | [varchar](./docs/api/appkit/Function.varchar.md) | - |