Revise README for Agent Stack Server SDK

[jenna-winkler]

Updated README to provide a comprehensive overview of the Agent Stack Server SDK, including installation instructions, key features, and usage examples.

Summary

Linked Issues

Documentation

• No Docs Needed:

If this PR adds new feature or changes existing. Make sure documentation is adjusted accordingly. If the docs is not needed, please explain why.

[gemini-code-assist]

Summary of Changes

Hello @jenna-winkler, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the README.md for the Agent Stack Server SDK, transforming it from a minimal document into a comprehensive guide. The update aims to provide users with a clearer understanding of the SDK's purpose, its key features, and how to get started quickly, thereby improving the onboarding experience and overall documentation quality.

Highlights

• Comprehensive SDK Overview: The README now provides a detailed overview of the Agent Stack Server SDK, explaining its purpose and how it facilitates agent deployment.
• Key Features Outlined: A new section clearly lists the core functionalities of the SDK, including framework-agnostic deployment, A2A protocol support, platform service integration, and context storage.
• Installation and Quickstart Guide: Clear installation instructions using uv add agentstack-sdk and a practical Python code example for quickly setting up and running an agent have been added.
• Detailed Extension Information: The document now includes a section on available extensions, such as Citations, Trajectory, Settings, LLM Services, and Agent Details, with links to further documentation.
• Enhanced Resource and Community Links: New sections provide links to documentation, GitHub repository, PyPI package, contributing guidelines, and support channels, along with a footer acknowledging the BeeAI project and Linux Foundation AI & Data.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request provides a much-needed comprehensive update to the README.md for the Python SDK. The new content is well-structured and covers key aspects like installation, features, and a quickstart guide. I've provided a few suggestions on the quickstart code example to fix a bug and align it with Python best practices, ensuring new users have a smooth and correct starting point.

[gemini-code-assist]

The os.getenv function's default value must be a string. Providing an integer 8000 will cause a TypeError if the PORT environment variable is not set. The default value should be a string, "8000", which is then converted to an integer.

Suggested change

	port=int(os.getenv("PORT", 8000)),
	port=int(os.getenv("PORT", "8000")),

[gemini-code-assist]

The my_agent function is an async generator, but it lacks a return type hint. Adding a type hint makes the function's contract explicit, improving readability and enabling better static analysis. You'll need to import AsyncGenerator from collections.abc at the top of the file.

Suggested change

	async def my_agent(
	input: Message,
	context: RunContext,
	):
	async def my_agent(
	input: Message,
	context: RunContext,
	) -> "AsyncGenerator[str, None]":

[gemini-code-assist]

According to PEP 8, imports should be at the top of the file. The import for AgentMessage should be moved to the top of the file with the other imports to improve readability and make dependencies clear. Please add from agentstack_sdk.a2a.types import AgentMessage at the top of the code block.

Suggested change

	from agentstack_sdk.a2a.types import AgentMessage
	await context.store(AgentMessage(text=response_text))
	await context.store(AgentMessage(text=response_text))