azure-ai-agentserver-activity 1.0.0b1

Activity protocol host for Azure AI Hosted Agents

Azure AI Agent Server Activity client library for Python

The azure-ai-agentserver-activity package provides the Foundry container integration host for Activity Protocol traffic in Azure AI Hosted Agent containers. It plugs into azure-ai-agentserver-core and exposes a protocol endpoint with Foundry-required header, tracing, and error behavior.

Getting started

Install the package

pip install azure-ai-agentserver-activity

Prerequisites

• Python 3.10 or later

Key concepts

ActivityAgentServerHost

ActivityAgentServerHost is an AgentServerHost subclass for Activity Protocol traffic. It provides:

• POST /activity/messages (and the POST /api/messages alias) for inbound activities.

Usage patterns

Build the M365 stack (default) — register handlers on the host's agent_app:

from azure.ai.agentserver.activity import ActivityAgentServerHost

host = ActivityAgentServerHost()
app = host.agent_app

@app.activity("message")
async def on_message(context, state):
    await context.send_activity(f"Echo: {context.activity.text}")

@app.error
async def on_error(context, error):
    await context.send_activity(f"Error: {error}")

host.run()

Build the M365 stack, with overrides — same default path, but override any components you want to control (the host builds the rest from the environment):

from microsoft_agents.hosting.core import MemoryStorage
from azure.ai.agentserver.activity import ActivityAgentServerHost

# Override just the storage backend; connection manager / adapter / authorization
# / config are still built for you. Add digital_worker=True for the blueprint model.
app = ActivityAgentServerHost(storage=MemoryStorage())

Inject a pre-built AgentApplication — host an M365 AgentApplication you built yourself:

from azure.ai.agentserver.activity import ActivityAgentServerHost

# agent_app: a fully-built microsoft_agents AgentApplication (with an adapter)
host = ActivityAgentServerHost(agent_app=agent_app)
host.run()

Custom handler — you own the request pipeline (the M365 SDK is not initialized):

from starlette.responses import Response

from azure.ai.agentserver.activity import ActivityAgentServerHost

async def handle(request):
    activity = request.state.activity  # parsed dict
    # Custom processing...
    return Response(status_code=202)

host = ActivityAgentServerHost(request_handler=handle)
host.run()

Request header contract

POST /activity/messages consumes:

• agent_session_id query parameter (highest-precedence session source), then the x-agent-session-id header, then config, then a generated UUID fallback
• x-agent-conversation-id
• x-agent-user-id (per-user identity) and x-agent-foundry-call-id (per-request call ID, container protocol 2.0.0)
• traceparent, tracestate, and baggage

Public API

• ActivityAgentServerHost — the host class. Constructed directly, it builds the M365 stack and exposes the built AgentApplication as the agent_app property: register handlers on it (host.agent_app.activity/error/message/proactive/auth ...). Optional keyword overrides: digital_worker, storage, connection_manager, adapter, authorization, connection_config.
• ActivityAgentServerHost(agent_app=agent_app) — host a pre-built M365 AgentApplication (the adapter is taken from agent_app.adapter).
• ActivityAgentServerHost(request_handler=handler) — host a custom async request handler; the M365 SDK is not initialized.
• get_hosted_agent_env(*, digital_worker=False) — return a config mapping (os.environ overlaid with the derived CONNECTIONS__* settings from the Foundry-native FOUNDRY_AGENT_* env) without mutating the environment. The default constructor derives this for you; call it yourself only when you build the MsalConnectionManager (or a pre-built AgentApplication) manually — see the 03-self-hosted-app sample.
• ActivityAgentServerHost.agent_app — the underlying M365 AgentApplication (available when the host builds or is given one).
• ActivityAgentServerHost.adapter — the channel adapter for the underlying AgentApplication.

Examples

See the samples directory for runnable scenarios, ordered as a learning path:

• 01-echo — the simplest agent: the host builds the M365 stack and you register handlers directly on it to echo the user's message back.
• 02-custom-components — override one or more M365 components (storage, connection manager, adapter, authorization, config) while the host builds the rest.
• 03-self-hosted-app — build the M365 AgentApplication yourself and host it by passing agent_app=.
• 04-custom-handler — own the request pipeline with request_handler= (the M365 SDK is not initialized).
• 05-multi-protocol — compose the Activity and Invocations protocols on a single server.

Troubleshooting

ImportError: M365 Agents SDK not installed

The M365 Agents SDK ships as a dependency of this package, so a standard pip install azure-ai-agentserver-activity covers the default ActivityAgentServerHost() path. If you have deliberately trimmed the M365 packages from your environment, reinstall them:

pip install microsoft-agents-hosting-core microsoft-agents-authentication-msal microsoft-agents-activity azure-identity

Alternatively, use ActivityAgentServerHost(request_handler=...), which does not initialize the M365 SDK.

TypeError: handler must be an async function

request_handler=... requires an async def handler (async def handle(request) -> Response). A plain def is rejected.

AttributeError when accessing agent_app

host.agent_app (and handler registration via @host.agent_app.activity(...) / @host.agent_app.error) is only available when the host builds or is given an M365 AgentApplication (the default constructor or agent_app=). A host created with request_handler=... does not expose the M365 surface.

Next steps

• Check the azure-ai-agentserver-core package for base host functionality

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [e-mail] with any additional questions or comments.