Microsoft Agent Framework Integration for Claude

1.0.0b260409 · active · verified Thu Apr 16

The `agent-framework-claude` library provides an integration for using Anthropic's Claude models within Microsoft's Agent Framework. Currently in beta version `1.0.0b260409`, it is part of an actively developed monorepo (`microsoft/agentframework`) with frequent pre-releases, indicating potential for rapid changes and feature updates.

Common errors

```
ModuleNotFoundError: No module named 'agent_framework_claude'
```
cause Incorrect import path. The package is part of the broader `agentframework` and its module is nested.

fix Use `from agentframework.integrations.claude import ClaudeAgent`.
```
anthropic.types.errors.AuthenticationError: invalid x-api-key: ...
```
cause The Anthropic API key is missing or invalid.

fix Set the `ANTHROPIC_API_KEY` environment variable or pass a valid key directly to `ClaudeAgent(anthropic_api_key='...')`. Double-check the key for typos and ensure it has the correct permissions.
```
TypeError: object NoneType can't be used in 'await' expression
```
cause Often occurs when an asynchronous method (like `agent.invoke()`) returns `None` due to an error during initialization, and `await` is called on it.

fix Check `ClaudeAgent` initialization parameters, especially `anthropic_api_key` and `model`. Ensure the API key is valid and the model name exists and is accessible.

Warnings

breaking As a beta package (`1.0.0b...`), `agent-framework-claude` is subject to frequent breaking changes without major version bumps. API signatures, class names, or core functionalities may change between minor pre-release versions.
Fix: Always pin to specific versions (e.g., `agent-framework-claude==1.0.0b260409`) and consult the latest GitHub documentation for updates.
gotcha The `ClaudeAgent` constructor requires an `anthropic_api_key`. If this is not provided, or if the `ANTHROPIC_API_KEY` environment variable is not set, API calls will fail with authentication errors.
Fix: Ensure `os.environ['ANTHROPIC_API_KEY']` is set, or pass `anthropic_api_key='YOUR_API_KEY'` directly to the `ClaudeAgent` constructor.
gotcha The library is built on `asyncio`. All interactions with the agent (e.g., `agent.invoke()`) are asynchronous and must be `await`ed within an `async` function. Calling them directly will result in a `coroutine object` being returned, not the actual result.
Fix: Wrap your agent interactions in `async def` functions and use `await`. Run your main async function using `asyncio.run(main())`.

Install

pip install agent-framework-claude Install latest beta

Imports

ClaudeAgent
wrong:
```
from agent_framework_claude import ClaudeAgent
```
correct:
```
from agentframework.integrations.claude import ClaudeAgent
```
The library is part of the 'agentframework' monorepo, so its module path is nested under `agentframework.integrations`.

Quickstart

This quickstart initializes a `ClaudeAgent` and demonstrates a simple asynchronous interaction. Ensure your `ANTHROPIC_API_KEY` is set as an environment variable or passed directly. The `model` parameter is recommended for explicit control.

import os
import asyncio
from agentframework.integrations.claude import ClaudeAgent

async def main():
    # Ensure ANTHROPIC_API_KEY is set in your environment
    anthropic_api_key = os.environ.get('ANTHROPIC_API_KEY', '')
    if not anthropic_api_key:
        print("Warning: ANTHROPIC_API_KEY environment variable not set. Agent may not function.")

    agent = ClaudeAgent(
        name="Claude",
        description="An agent that uses Claude for general purpose reasoning.",
        anthropic_api_key=anthropic_api_key,
        model="claude-3-opus-20240229" # Specify your desired Claude model
    )

    # Example interaction
    response = await agent.invoke("What is the capital of France?")
    print(f"Claude's response: {response}")

if __name__ == '__main__':
    asyncio.run(main())

view raw JSON →