mirror of https://github.com/microsoft/agent-framework.git synced 2026-06-16 21:04:09 +08:00

Files

T

Eduard van Valkenburg 534e5f5bf7 Python: improve .env handling and observability samples (#4032 )

* Python: improve .env precedence and observability samples

- Switch load_settings to explicit precedence: overrides -> explicit .env -> environment -> defaults\n- Raise when env_file_path is provided but missing\n- Update settings docs and tests for new behavior\n- Refresh observability samples and README guidance for env loading options\n\nCloses #3864\n\nCo-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fixed some imports

* Fix load_settings CI regressions

Allow explicit env_file_path values that exist but are not regular files (for example /dev/null) by checking path existence before dotenv parsing, and restore a dict accumulator with typed return cast to satisfy mypy.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Avoid implicit dotenv in observability

Only load dotenv in observability helpers when env_file_path is explicitly provided, and remove test os.devnull workarounds that are no longer necessary.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

534e5f5bf7 · 2026-02-18 11:18:52 +00:00

History

agent_framework_copilotstudio

Python: improve .env handling and observability samples (#4032 )

2026-02-18 11:18:52 +00:00

tests

Python: [BREAKING] PR2 — Wire context provider pipeline, remove old types, update all consumers (#3850 )

2026-02-12 21:00:32 +00:00

AGENTS.md

.NET: Python: Add AGENTS.md files and update coding standards (#3644 )

2026-02-05 10:27:46 +00:00

LICENSE

Python: Added Copilot Studio Agent (#722 )

2025-09-15 23:21:07 +00:00

pyproject.toml

update package versions (#3902 )

2026-02-13 00:00:57 +00:00

README.md

Python: restructure: Python samples into progressive 01-05 layout (#3862 )

2026-02-12 17:36:36 +00:00

README.md

Get Started with Microsoft Agent Framework Copilot Studio

Please install this package via pip:

pip install agent-framework-copilotstudio --pre

Copilot Studio Agent

The Copilot Studio agent enables integration with Microsoft Copilot Studio, allowing you to interact with published copilots through the Agent Framework.

Prerequisites

Before using the Copilot Studio agent, you need:

Copilot Studio Environment: Access to a Microsoft Copilot Studio environment with a published copilot
App Registration: An Azure AD App Registration with appropriate permissions for Power Platform API
Environment Configuration: Set the required environment variables or pass them as parameters

Environment Variables

The following environment variables are used for configuration:

COPILOTSTUDIOAGENT__ENVIRONMENTID - Your Copilot Studio environment ID
COPILOTSTUDIOAGENT__SCHEMANAME - Your copilot's agent identifier/schema name
COPILOTSTUDIOAGENT__AGENTAPPID - Your App Registration client ID
COPILOTSTUDIOAGENT__TENANTID - Your Azure AD tenant ID

Basic Usage Example

import asyncio
from agent_framework.microsoft import CopilotStudioAgent

async def main():
    # Create agent using environment variables
    agent = CopilotStudioAgent()

    # Run a simple query
    result = await agent.run("What is the capital of France?")
    print(result)

asyncio.run(main())

Explicit Configuration Example

import asyncio
import os
from agent_framework.microsoft import CopilotStudioAgent, acquire_token
from microsoft_agents.copilotstudio.client import ConnectionSettings, CopilotClient, PowerPlatformCloud, AgentType

async def main():
    # Acquire authentication token
    token = acquire_token(
        client_id=os.environ["COPILOTSTUDIOAGENT__AGENTAPPID"],
        tenant_id=os.environ["COPILOTSTUDIOAGENT__TENANTID"]
    )

    # Create connection settings
    settings = ConnectionSettings(
        environment_id=os.environ["COPILOTSTUDIOAGENT__ENVIRONMENTID"],
        agent_identifier=os.environ["COPILOTSTUDIOAGENT__SCHEMANAME"],
        cloud=PowerPlatformCloud.PROD,
        copilot_agent_type=AgentType.PUBLISHED,
        custom_power_platform_cloud=None
    )

    # Create client and agent
    client = CopilotClient(settings=settings, token=token)
    agent = CopilotStudioAgent(client=client)

    # Run a query
    result = await agent.run("What is the capital of Italy?")
    print(result)

asyncio.run(main())

Authentication

The package uses MSAL (Microsoft Authentication Library) for authentication with interactive flows when needed. Ensure your App Registration has:

API Permissions: Power Platform API permissions (https://api.powerplatform.com/.default)
Redirect URIs: Configured appropriately for your authentication method
Public Client Flows: Enabled if using interactive authentication

Examples

For more comprehensive examples, see the Copilot Studio examples which demonstrate:

Basic non-streaming and streaming execution
Explicit settings and manual token acquisition
Different authentication patterns
Error handling and troubleshooting