docs / agents-sdk / examplesgithub.com/Fareground/agents-sdk ↗

Examples

Start with the quickstart for a complete tool-using conversation.

The repository's examples directory includes a facade hello-world, tools, persistence, a web application and frontend SSE clients. Install the extras required by the example and configure its selected provider.

Develop from an editable source checkout

Normal users should install from PyPI. Clone GitHub only when changing the SDK itself or running repository examples against an editable checkout.

git clone https://github.com/Fareground/agents-sdk.git
cd agents-sdk
git checkout v0.4.7
python -m pip install -e ".[anthropic,web,sqlite]"

Suggested progression

  1. Run one prompt and inspect AgentRunResult.
  2. Add one read-only business tool and inspect its generated schema.
  3. Continue a conversation with the same session.
  4. Persist it to SQLite and verify it survives a restart.
  5. Stream events to your UI.
  6. Add authentication and the application's production boundaries before exposing it.

For an environment-building agent, give it access to the environments-sdk's guide, checker and controlled execution tools. Require scenario-level tests and inspect the generated contract before running it for a customer.

Names, versions and migration

Surface Name
Product agents-sdk
GitHub repository Fareground/agents-sdk
Python distribution fg-agents
Python import fg_agents

The public rename does not change installation commands or imports. If your checkout still uses a legacy repository URL, update its remote:

git remote set-url origin https://github.com/Fareground/agents-sdk.git

These pages document version 0.4.7. Pin deployed dependencies, read the changelog, and run provider, tool and persistence acceptance checks before upgrading.

Existing compatibility identifiers such as AgentFrameworkError remain unchanged. Renaming an exception or import solely to match product branding would be a separate breaking change.

PreviousAPI reference