You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: integrations/appkit-agent/README.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,23 +1,23 @@
1
1
# @databricks/appkit-agent
2
2
3
-
Agent plugin for [Databricks AppKit](https://github.com/databricks/appkit). Provides two things:
3
+
Agent plugin for [Databricks AppKit](https://github.com/databricks/appkit). You can define an agent using one of the following approaches:
4
4
5
-
1.**`AgentInterface`** — a contract for writing custom agent implementations that speak the OpenAI Responses API format (streaming + non-streaming).
6
-
2.**`StandardAgent`** — a ready-to-use LangGraph-based ReAct agent that implements `AgentInterface`, with streaming Responses API support, function tools, and Databricks-hosted tool integration (Genie, Vector Search, MCP servers).
5
+
1.Declaratively define an agent by specifying `model`, `tools,` and `instructions`
6
+
2.Implement a custom agent loop using **`AgentInterface`** — a contract for writing custom agent implementations that speak the OpenAI Responses API format (streaming + non-streaming).
7
7
8
8
## Installation
9
9
10
10
```bash
11
11
npm install @databricks/appkit-agent
12
12
```
13
13
14
-
The LangChain peer dependencies are required when using the built-in ReAct agent (not needed if you provide a custom `agentInstance`):
14
+
The following peer dependencies are required when using the built-in agent (not needed if you provide a custom `agentInstance`):
If you use hosted MCP tools (Genie, Vector Search, custom/external MCP servers):
20
+
If you use hosted tools (Genie, Vector Search, custom/external MCP servers):
21
21
22
22
```bash
23
23
npm install @langchain/mcp-adapters
@@ -63,7 +63,7 @@ agent({
63
63
// Tools available to the agent (see Tools section below)
64
64
tools: [myTool, genieTool],
65
65
66
-
// Or bring your own AgentInterface implementation (skips LangGraph setup)
66
+
// Or bring your own AgentInterface implementation
67
67
agentInstance: myCustomAgent,
68
68
});
69
69
```
@@ -109,7 +109,7 @@ Connect to Databricks-managed services without writing tool handlers:
109
109
```typescript
110
110
// Genie Space — natural-language queries over your data
111
111
const genie = {
112
-
type: "genie-space"asconst,
112
+
type: "genie_space"asconst,
113
113
genie_space: { id: "01efg..." },
114
114
};
115
115
@@ -214,7 +214,7 @@ class MyAgent implements AgentInterface {
214
214
agent({ agentInstance: newMyAgent() });
215
215
```
216
216
217
-
The `StandardAgent` class (exported from this package) is the built-in implementation that wraps a LangGraph `createReactAgent` and translates its stream events into Responses API format. When you pass `model` instead of `agentInstance`, the plugin uses `StandardAgent` under the hood.
217
+
The `StandardAgent` class (exported from this package) is the built-in implementation used when you pass `model` instead of `agentInstance`. It translates the underlying agent's stream events into Responses API format.
218
218
219
219
## API Reference
220
220
@@ -223,7 +223,7 @@ The `StandardAgent` class (exported from this package) is the built-in implement
0 commit comments