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: docs/docs/api/appkit/Interface.IAgentConfig.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,6 @@
1
1
# Interface: IAgentConfig
2
2
3
-
Base configuration interface for AppKit plugins.
4
-
5
-
When you do **not** set `agentInstance`, the agent is built from `model`, `tools`, and `mcpServers`. You can then add more tools or MCP servers after app creation via `appkit.agent.addCapabilities()` (see [agent](Variable.agent.md) Plugin API).
3
+
Base configuration interface for AppKit plugins
6
4
7
5
## Extends
8
6
@@ -27,7 +25,7 @@ When provided the plugin skips internal LangGraph setup and delegates
27
25
directly to this instance. Use this to bring your own agent
Max tokens to generate (default 2000). Ignored when `agentInstance` is provided.
51
49
52
-
---
50
+
***
53
51
54
52
### mcpServers?
55
53
56
54
```ts
57
55
optionalmcpServers: DatabricksMCPServer[];
58
56
```
59
57
60
-
MCP servers for Databricks tool integration. Ignored when `agentInstance` is provided. You can add more at runtime with `appkit.agent.addCapabilities({ mcpServers: [...] })`.
58
+
MCP servers for Databricks tool integration. Ignored when `agentInstance` is provided.
61
59
62
-
---
60
+
***
63
61
64
62
### model?
65
63
@@ -71,7 +69,7 @@ Databricks model serving endpoint name (e.g. "databricks-claude-sonnet-4-5").
Additional LangChain tools to register alongside MCP tools. Ignored when `agentInstance` is provided. You can add more at runtime with `appkit.agent.addCapabilities({ tools: [...] })`.
124
+
Tools to register with the agent. Accepts OpenResponses-aligned FunctionTool
125
+
objects or LangChain StructuredToolInterface instances.
Plugin factory for the AppKit agent (LangChain/LangGraph). Use in `createApp({ plugins: [agent({ ... })] })`. Configuration: [`IAgentConfig`](Interface.IAgentConfig.md).
|`invoke(messages)`| Run the agent (non-streaming). Returns the assistant reply text. |
16
-
|`stream(messages)`| Run the agent with streaming. Yields [`ResponseStreamEvent`](TypeAlias.ResponseStreamEvent.md)s. |
17
-
|`addCapabilities({ tools?, mcpServers? })`| Batch-add tools and/or MCP servers with a **single** agent rebuild. **Only when not using `agentInstance`.**|
18
-
|`addTools(tools)`| Add LangChain tools after app creation. Rebuilds the agent. Convenience wrapper around `addCapabilities`. **Only when not using `agentInstance`.**|
19
-
|`addMcpServers(servers)`| Add MCP servers after app creation. Rebuilds the agent and MCP client. Convenience wrapper around `addCapabilities`. **Only when not using `agentInstance`.**|
20
-
21
-
When the plugin is configured with `model` and optional `tools` / `mcpServers` (i.e. without `agentInstance`), prefer `addCapabilities` to register both tools and MCP servers in one call instead of sequential `addTools` + `addMcpServers` (which would rebuild the agent twice).
Copy file name to clipboardExpand all lines: docs/docs/api/appkit/index.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,6 +34,7 @@ plugin architecture, and React integration.
34
34
|[BasePluginConfig](Interface.BasePluginConfig.md)| Base configuration interface for AppKit plugins |
35
35
|[CacheConfig](Interface.CacheConfig.md)| Configuration for caching |
36
36
|[DatabaseCredential](Interface.DatabaseCredential.md)| Database credentials with OAuth token for Postgres connection |
37
+
|[FunctionTool](Interface.FunctionTool.md)| - |
37
38
|[GenerateDatabaseCredentialRequest](Interface.GenerateDatabaseCredentialRequest.md)| Request parameters for generating database OAuth credentials |
38
39
|[IAgentConfig](Interface.IAgentConfig.md)| Base configuration interface for AppKit plugins |
39
40
|[InvokeParams](Interface.InvokeParams.md)| Agent interface types for the AppKit Agent Plugin. |
@@ -54,6 +55,7 @@ plugin architecture, and React integration.
54
55
55
56
| Type Alias | Description |
56
57
| ------ | ------ |
58
+
|[AgentTool](TypeAlias.AgentTool.md)| A tool that can be registered with the agent plugin. |
57
59
|[ConfigSchema](TypeAlias.ConfigSchema.md)| Configuration schema definition for plugin config. Re-exported from the standard JSON Schema Draft 7 types. |
58
60
|[IAppRouter](TypeAlias.IAppRouter.md)| Express router type for plugin route registration |
59
61
|[PluginData](TypeAlias.PluginData.md)| - |
@@ -65,7 +67,7 @@ plugin architecture, and React integration.
65
67
66
68
| Variable | Description |
67
69
| ------ | ------ |
68
-
|[agent](Variable.agent.md)|Agent plugin factory; runtime API includes invoke, stream, addCapabilities, addTools, addMcpServers.|
0 commit comments