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

Metadata

Release files for agent-framework-copilotstudio 1.0.0b251111

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for agent-framework-copilotstudio 1.0.0b251111
File	Size	Uploaded
agent_framework_copilotstudio-1.0.0b251111.tar.gz	12.0 kB	Nov 11, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for agent-framework-copilotstudio 1.0.0b251111
File	Interpreter	ABI	Platform	Reset
agent_framework_copilotstudio-1.0.0b251111-py3-none-any.whl 8.7 kB Nov 11, 2025	Python 3	none	any	Details

Total release size: 20.7 kB

Release files / agent_framework_copilotstudio-1.0.0b251111.tar.gz

Download URL	agent_framework_copilotstudio-1.0.0b251111.tar.gz
Size	12.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`2caf18cc909149a59af03c18f48c48de92271951d753b9bfddbf0f670d43beb2`
BLAKE2b-256 checksum How to use checksums	`e80f3d917925b3b5c17de0a5f70191266320344f8774172ddf24d685c094acab`
Upload date	Nov 11, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.8.24`

Release files / agent_framework_copilotstudio-1.0.0b251111-py3-none-any.whl

Download URL	agent_framework_copilotstudio-1.0.0b251111-py3-none-any.whl
Size	8.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`20e0e3ce0ea032444a4d0a3d11b591dd744598f6ac15497f1a6b0614f368a0c7`
BLAKE2b-256 checksum How to use checksums	`0ebdb6943b9a1a50e1fd2a17c24944ffe10f1d1899c921b171efc77b50abcb84`
Upload date	Nov 11, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.8.24`