Skip to content

Commit ea9981f

Browse files
authored
Python: Docs: Add Microsoft Agent Framework successor callout to READMEs (#13932)
## Motivation and Context Now that **Microsoft Agent Framework (MAF)** is the successor SDK to Semantic Kernel, the top-level and per-language READMEs should direct community members — especially newcomers landing here from search, GitHub, PyPI, or NuGet — to MAF for new work, and clearly state SK's ongoing maintenance posture. ## Description Adds a prominent GitHub `> [!IMPORTANT]` callout, placed directly under the existing title/badges block, to: - `README.md` (top-level) - `python/README.md` - `dotnet/README.md` Each callout: - Names MAF as Semantic Kernel's successor SDK and links to https://github.com/microsoft/agent-framework. - Describes MAF as "an open, multi-language framework for building production-grade AI agents and multi-agent workflows in .NET and Python". - Asks readers to use MAF for the latest abstractions to build agents, workflows, and multi-agent orchestrations. - States that Semantic Kernel will continue to receive minimal security and bug fixes only. No other README content is modified; SK identity, badges, install steps, and quickstart samples are preserved. ## Contribution Checklist - [x] The code builds clean without any errors or warnings — docs-only change. - [x] I didn't break anyone — additive callout only. - [x] All relevant CONTRIBUTING.md sections were followed.
1 parent 27971e1 commit ea9981f

3 files changed

Lines changed: 24 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
# Semantic Kernel
22

3+
> [!IMPORTANT]
4+
> Semantic Kernel is now [Microsoft Agent Framework](https://github.com/microsoft/agent-framework)! Microsoft Agent Framework (MAF) is the enterprise‑ready successor to Semantic Kernel. Microsoft Agent Framework is now available at version 1.0 as a production-ready release: stable APIs, and a commitment to long-term support. Whether you're building a single assistant or orchestrating a fleet of specialized agents, Microsoft Agent Framework 1.0 gives you enterprise-grade multi-agent orchestration, multi-provider model support, and cross-runtime interoperability via A2A and MCP.
5+
>
6+
> Learn more about Semantic Kernel and Agent Framework here: [Semantic Kernel and Microsoft Agent Framework on the Agent Framework blog](https://devblogs.microsoft.com/agent-framework/semantic-kernel-and-microsoft-agent-framework/), and try out the [Semantic Kernel migration guide](https://learn.microsoft.com/en-us/agent-framework/migration-guide/from-semantic-kernel).
7+
38
**Build intelligent AI agents and multi-agent systems with this enterprise-ready orchestration framework**
49

510
[![License: MIT](https://img.shields.io/github/license/microsoft/semantic-kernel)](https://github.com/microsoft/semantic-kernel/blob/main/LICENSE)
611
[![Python package](https://img.shields.io/pypi/v/semantic-kernel)](https://pypi.org/project/semantic-kernel/)
712
[![Nuget package](https://img.shields.io/nuget/vpre/Microsoft.SemanticKernel)](https://www.nuget.org/packages/Microsoft.SemanticKernel/)
813
[![Discord](https://img.shields.io/discord/1063152441819942922?label=Discord&logo=discord&logoColor=white&color=d82679)](https://aka.ms/SKDiscord)
914

10-
1115
## What is Semantic Kernel?
1216

1317
Semantic Kernel is a model-agnostic SDK that empowers developers to build, orchestrate, and deploy AI agents and multi-agent systems. Whether you're building a simple chatbot or a complex multi-agent workflow, Semantic Kernel provides the tools you need with enterprise-grade reliability and flexibility.

dotnet/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Get Started with Semantic Kernel ⚡
22

3+
> [!IMPORTANT]
4+
> Semantic Kernel is now [Microsoft Agent Framework](https://github.com/microsoft/agent-framework)! Microsoft Agent Framework (MAF) is the enterprise‑ready successor to Semantic Kernel. Microsoft Agent Framework is now available at version 1.0 as a production-ready release: stable APIs, and a commitment to long-term support. Whether you're building a single assistant or orchestrating a fleet of specialized agents, Microsoft Agent Framework 1.0 gives you enterprise-grade multi-agent orchestration, multi-provider model support, and cross-runtime interoperability via A2A and MCP.
5+
>
6+
> Learn more about Semantic Kernel and Agent Framework here: [Semantic Kernel and Microsoft Agent Framework on the Agent Framework blog](https://devblogs.microsoft.com/agent-framework/semantic-kernel-and-microsoft-agent-framework/), and try out the [Semantic Kernel migration guide](https://learn.microsoft.com/en-us/agent-framework/migration-guide/from-semantic-kernel).
7+
38
## OpenAI / Azure OpenAI API keys
49

510
To run the LLM prompts and semantic functions in the examples below, make sure

python/README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Get Started with Semantic Kernel Python
22

3+
> [!IMPORTANT]
4+
> Semantic Kernel is now [Microsoft Agent Framework](https://github.com/microsoft/agent-framework)! Microsoft Agent Framework (MAF) is the enterprise‑ready successor to Semantic Kernel. Microsoft Agent Framework is now available at version 1.0 as a production-ready release: stable APIs, and a commitment to long-term support. Whether you're building a single assistant or orchestrating a fleet of specialized agents, Microsoft Agent Framework 1.0 gives you enterprise-grade multi-agent orchestration, multi-provider model support, and cross-runtime interoperability via A2A and MCP.
5+
>
6+
> Learn more about Semantic Kernel and Agent Framework here: [Semantic Kernel and Microsoft Agent Framework on the Agent Framework blog](https://devblogs.microsoft.com/agent-framework/semantic-kernel-and-microsoft-agent-framework/), and try out the [Semantic Kernel migration guide](https://learn.microsoft.com/en-us/agent-framework/migration-guide/from-semantic-kernel).
7+
38
Highlights
49
- Flexible Agent Framework: build, orchestrate, and deploy AI agents and multi-agent systems
510
- Multi-Agent Systems: Model workflows and collaboration between AI specialists
@@ -126,6 +131,7 @@ from semantic_kernel.agents import ChatCompletionAgent
126131
from semantic_kernel.connectors.ai.open_ai import AzureChatCompletion, OpenAIChatPromptExecutionSettings
127132
from semantic_kernel.functions import kernel_function, KernelArguments
128133

134+
129135
class MenuPlugin:
130136
@kernel_function(description="Provides a list of specials from the menu.")
131137
def get_specials(self) -> Annotated[str, "Returns the specials from the menu."]:
@@ -141,11 +147,13 @@ class MenuPlugin:
141147
) -> Annotated[str, "Returns the price of the menu item."]:
142148
return "$9.99"
143149

150+
144151
class MenuItem(BaseModel):
145152
# Used for structured outputs
146153
price: float
147154
name: str
148155

156+
149157
async def main():
150158
# Configure structured outputs format
151159
settings = OpenAIChatPromptExecutionSettings()
@@ -157,7 +165,7 @@ async def main():
157165
name="SK-Assistant",
158166
instructions="You are a helpful assistant.",
159167
plugins=[MenuPlugin()],
160-
arguments=KernelArguments(settings)
168+
arguments=KernelArguments(settings),
161169
)
162170

163171
response = await agent.get_response("What is the price of the soup special?")
@@ -166,7 +174,8 @@ async def main():
166174
# Output:
167175
# The price of the Clam Chowder, which is the soup special, is $9.99.
168176

169-
asyncio.run(main())
177+
178+
asyncio.run(main())
170179
```
171180

172181
You can explore additional getting started agent samples [here](https://github.com/microsoft/semantic-kernel/tree/main/python/samples/getting_started_with_agents).
@@ -181,6 +190,7 @@ from semantic_kernel.agents import ChatCompletionAgent, GroupChatOrchestration,
181190
from semantic_kernel.agents.runtime import InProcessRuntime
182191
from semantic_kernel.connectors.ai.open_ai import AzureChatCompletion
183192

193+
184194
def get_agents():
185195
return [
186196
ChatCompletionAgent(
@@ -195,6 +205,7 @@ def get_agents():
195205
),
196206
]
197207

208+
198209
async def main():
199210
agents = get_agents()
200211
group_chat = GroupChatOrchestration(
@@ -215,6 +226,7 @@ async def main():
215226

216227
await runtime.stop_when_idle()
217228

229+
218230
if __name__ == "__main__":
219231
asyncio.run(main())
220232
```

0 commit comments

Comments
 (0)