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
feat: AL-213760: add warning and deprecation notice. cite 1.0.0rc2 (#73)
* add warning and deprecation notice. cite 1.0.0rc2
* bump pyproject versions
* repeat major version announcement in each package
* modify default tools for MCP. add instructions for reenabling.
@@ -86,6 +86,32 @@ If you cannot obtain service account credentials (admin only), see the [User Acc
86
86
87
87
## New Major Version 1.x.x
88
88
89
+
#### Dec 10, 2025 Update
90
+
`1.0.0rc2` version of the Alation AI Agent SDK is now available.
91
+
92
+
It deprecates the Context Tool in favor of the more capable Catalog Context Search Agent. On the practical side, Catalog Context Search Agent shares the same contract so any migrations should be straightforward.
93
+
94
+
We've committed to keep the now deprecated Context Tool as part of the SDK for the next **three months for transition**. This means you should expect to see it **removed in Feb 2026**.
95
+
96
+
The main rationale for removing the Context Tool originates from having two tools which do very similar things. When both are exposed to an LLM, the model often picks the less capable one leading to worse outcomes. By reducing the number of tools that overlap conceptually, we're avoiding the wrong tool selection.
97
+
98
+
The Catalog Context Search Agent will do all the things the Context Tool did AND more like dynamically construct the `signature` parameter which was a major bottleneck when using the Context Tool.
99
+
100
+
Our local MCP server was changed for the same reason and no longer includes Context Tool, Analyze Catalog Question, Signature Create, or Bulk Retrieval by default. The Catalog Context Search Agent will invoke these internally as needed without requiring them in scope.
101
+
102
+
If you have prompts that expect any of those specific tools, you'll need to tell the MCP server which tools you wish to have enabled (overriding the default set). This can be done as a command line argument or as an environment variable.
103
+
104
+
Reminder: If you have a narrow use case, only enable the tools that are needed for that particular case.
105
+
106
+
```bash
107
+
# As command line arguments to the MCP server command
We're excited to announce the `1.0.0rc1` version of the Alation AI Agent SDK is available.
90
116
91
117
IMPORTANT: In a breaking change `user_account` is no longer supported as an authorization mode. We recommend you migrate to `service_account` or `bearer_token` modes.
Copy file name to clipboardExpand all lines: python/core-sdk/README.md
+78-2Lines changed: 78 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,82 @@ This SDK provides a simple, programmatic way for AI applications to:
10
10
- Search for and retrieve data products by product ID or natural language queries
11
11
- Customize response formats using signature specifications
12
12
13
+
## New Major Version 1.x.x
14
+
15
+
#### Dec 10, 2025 Update
16
+
`1.0.0rc2` version of the Alation AI Agent SDK is now available.
17
+
18
+
It deprecates the Context Tool in favor of the more capable Catalog Context Search Agent. On the practical side, Catalog Context Search Agent shares the same contract so any migrations should be straightforward.
19
+
20
+
We've committed to keep the now deprecated Context Tool as part of the SDK for the next **three months for transition**. This means you should expect to see it **removed in Feb 2026**.
21
+
22
+
The main rationale for removing the Context Tool originates from having two tools which do very similar things. When both are exposed to an LLM, the model often picks the less capable one leading to worse outcomes. By reducing the number of tools that overlap conceptually, we're avoiding the wrong tool selection.
23
+
24
+
The Catalog Context Search Agent will do all the things the Context Tool did AND more like dynamically construct the `signature` parameter which was a major bottleneck when using the Context Tool.
25
+
26
+
Our local MCP server was changed for the same reason and no longer includes Context Tool, Analyze Catalog Question, Signature Create, or Bulk Retrieval by default. The Catalog Context Search Agent will invoke these internally as needed without requiring them in scope.
27
+
28
+
If you have prompts that expect any of those specific tools, you'll need to tell the MCP server which tools you wish to have enabled (overriding the default set). This can be done as a command line argument or as an environment variable.
29
+
30
+
Reminder: If you have a narrow use case, only enable the tools that are needed for that particular case.
31
+
32
+
```bash
33
+
# As command line arguments to the MCP server command
We're excited to announce the `1.0.0rc1` version of the Alation AI Agent SDK is available.
42
+
43
+
IMPORTANT: In a breaking change `user_account` is no longer supported as an authorization mode. We recommend you migrate to `service_account` or `bearer_token` modes.
44
+
45
+
The new major version comes with several notable changes that should make the transition worth it.
46
+
- Alation Agent Studio Integration
47
+
- Remote MCP Server
48
+
- Catalog Search Context Agent
49
+
- Streaming and Chat ID Support
50
+
51
+
### Alation Agent Studio Integration
52
+
53
+
The Alation Agent Studio gives you first class support for creating and leveraging the agents your business needs. Whether you're improving catalog curation or building data-centric query agents, the Agent Studio makes it easy to create agents, hone them, and deploy them across your enterprise. It includes a number of expert tools that are ready to be used or composed together as building blocks for more complex scenarios. And any precision agents you build are available within the SDK or MCP server as tools (See `custom_agent`).
54
+
55
+
### Remote MCP Server
56
+
57
+
We've heard from a number of customers that want the flexibility of MCP servers without the responsibility of having to install or upgrade the SDK. With our remote MCP server you don't have to do any of that. After a one time MCP focused authorization setup, it can be as simple as adding a remote MCP server to your favorite MCP client like: `https://<your_instance>/ai/mcp`
58
+
59
+
Note: MCP clients and platforms are rapidly evolving. Not all of them support authorization flows the same way nor path parameters etc. If you're running into blockers, please file an Issue so we can investigate and come up with a plan. We do not support dynamic client registration so please use an MCP client that allows you to pass in a `client_id` and `client_secret`.
60
+
61
+
#### Start Here
62
+
63
+
One issue the remote MCP server solves is listing tools dynamically. This dynamic portion is doing a lot of work for us. For instance, it can filter out tools the current user cannot use or it can list brand new tools the SDK doesn't even know about.
64
+
65
+
And since the tools are resolved lazily instead of statically, it means the API contracts for those tools can also be dynamic. This avoids client server version mismatches which could otherwise break static integrations.
66
+
67
+
We will continue to support the SDK and issue new versions regularly, but if you're after a less brittle more robust integration, you should consider integrating directly with the remote MCP server as a starting place.
68
+
69
+
### Catalog Search Context Agent
70
+
71
+
In the beginning of the Agent SDK we had only one tool: Alation Context. It offered a powerful way to dynamically select the right objects and their properties to best address a particular question. It's powerful `signature` parameter made it suitable for cases even without an user question (Bulk Retrieval). At the same time we saw a fair bit of friction with LLM generated `signature` parameters being invalid or just outright wrong. And a surprising amount of usage involved no `signature` at all which frequently resulted in poor results.
72
+
73
+
We've sought to address these issues by moving from a collection of these tools (`alation_context`, `bulk_retrieval`) into an agent that performs a series of checks and heuristics to dynamically create a `signature` when needed to take advantage of your custom fields. That is our new `catalog_search_context_agent`.
74
+
75
+
This should translate into fewer instructions you need to convince these tools to play nice with each other. And at the same time increase the accuracy of calls.
76
+
77
+
### Streaming and Chat ID Support
78
+
79
+
#### Streaming
80
+
81
+
All tools now support a streaming option. Primarily this benefits our local MCP server in http mode. If your MCP clients support streaming you should now see some of the internal processing of tools and agents to give you more transparency into what is happening under the hood.
82
+
83
+
By default the SDK has streaming disabled but it can be enabled if you have a use case for it. To enable it pass a `sdk_options=AgentSDKOptions(enable_streaming=True)` argument to the `AlationAIAgentSDK` constructor. When streaming you'll need to loop over the result or yield from it to correctly handle the underlying generator.
84
+
85
+
#### Chat ID
86
+
87
+
Most of our tools and agents accept the `chat_id` parameter when invoked. Including this will associate that tool call with any other prior calls referencing the same `chat_id`. Any `chat_id` compatible tool will include a `chat_id` in the response.
0 commit comments