[appkit plugin] [3/x] Add appkit-agent documentation#385
Open
hubertzub-db wants to merge 5 commits intodatabricks:mainfrom
Open
[appkit plugin] [3/x] Add appkit-agent documentation#385hubertzub-db wants to merge 5 commits intodatabricks:mainfrom
hubertzub-db wants to merge 5 commits intodatabricks:mainfrom
Conversation
This was referenced Mar 19, 2026
hubertzub-db
force-pushed
the
stack/agent-plugin-p3
branch
from
cc59fe8 to
22f46f4
Compare
hubertzub-db
changed the title
smurching
reviewed
Mar 20, 2026
integrations/appkit-agent/README.md
Outdated
|
|
||
| ## Databricks Apps Deployment | ||
|
|
||
| When deploying to Databricks Apps, alias the agent endpoint to `/invocations`: |
Collaborator
There was a problem hiding this comment.
We should probably explain why (?) - to ensure Databricks product UIs support interacting with + chatting with the agent defined in the app
Author
There was a problem hiding this comment.
sg, added an improved description
hubertzub-db
force-pushed
the
stack/agent-plugin-p3
branch
9 times, most recently
from
f310a95 to
3aa9645
Compare
hubertzub-db
changed the title
hubertzub-db
force-pushed
the
stack/agent-plugin-p3
branch
from
3aa9645 to
9729f32
Compare
smurching
reviewed
Mar 23, 2026
integrations/appkit-agent/README.md
Outdated
| ```typescript | ||
| // Genie Space — natural-language queries over your data | ||
| const genie = { | ||
| type: "genie-space" as const, |
Collaborator
There was a problem hiding this comment.
should be genie_space not genie-space, right?
smurching
reviewed
Mar 23, 2026
integrations/appkit-agent/README.md
Outdated
| @@ -0,0 +1,246 @@ | |||
| # @databricks/appkit-agent | |||
|
|
|||
| Agent plugin for [Databricks AppKit](https://github.com/databricks/appkit). Provides two things: | |||
Collaborator
There was a problem hiding this comment.
Suggested change
| Agent plugin for [Databricks AppKit](https://github.com/databricks/appkit). Provides two things: | |
| Agent plugin for [Databricks AppKit](https://github.com/databricks/appkit). You can define an agent using one of the following approaches: |
smurching
reviewed
Mar 23, 2026
integrations/appkit-agent/README.md
Outdated
|
|
||
| Agent plugin for [Databricks AppKit](https://github.com/databricks/appkit). Provides two things: | ||
|
|
||
| 1. **`AgentInterface`** — a contract for writing custom agent implementations that speak the OpenAI Responses API format (streaming + non-streaming). |
Collaborator
There was a problem hiding this comment.
Suggested change
| 1. **`AgentInterface`** — a contract for writing custom agent implementations that speak the OpenAI Responses API format (streaming + non-streaming). | |
| 1. Declaratively define an agent by specifying `model`, `tools,` and `instructions` | |
| 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). |
Collaborator
There was a problem hiding this comment.
Maybe good to frame things this way - developers probably don't care (and in the code it's not super visible right?) that they're using StandardAgent etc
smurching
reviewed
Mar 23, 2026
integrations/appkit-agent/README.md
Outdated
| agent({ agentInstance: new MyAgent() }); | ||
| ``` | ||
|
|
||
| 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. |
Collaborator
There was a problem hiding this comment.
We can remove references to LangGraph to future-proof these docs (since we will likely change frameworks down the line)
smurching
reviewed
Mar 23, 2026
Collaborator
smurching
left a comment
smurching
left a comment
There was a problem hiding this comment.
Docs mostly look good! Minor comments, happy to stamp once addressed
hubertzub-db
force-pushed
the
stack/agent-plugin-p3
branch
from
9729f32 to
8fc367a
Compare
hubertzub-db
force-pushed
the
stack/agent-plugin-p3
branch
3 times, most recently
from
c10d565 to
99e2e0c
Compare
hubertzub-db
force-pushed
the
stack/agent-plugin-p3
branch
from
58ab4d8 to
25dfdc7
Compare
3 tasks
Move agent plugin source code into src/agent-plugin/ subfolder for better organization when hosting multiple plugins.
Signed-off-by: Hubert Zub <hubert.zub@databricks.com>
Signed-off-by: Hubert Zub <hubert.zub@databricks.com>
hubertzub-db
force-pushed
the
stack/agent-plugin-p3
branch
from
25dfdc7 to
96a56f3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🥞 Stacked PR
Summary
Adds
README.mdfor the@databricks/appkit-agentpackage covering:createApp+server()+agent()setup)model,systemPrompt,tools,agentInstance)executehandler)app.agent.addTools()invoke,stream)/invocations→/api/agentaliasing)AgentInterface