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

Files

T

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

* Add AGENTS.md files and update coding standards for Python

- Add root python/AGENTS.md with project structure and package links
- Add AGENTS.md for each package describing purpose and main classes
- Update .github/copilot-instructions.md with improved structure
- Update python/CODING_STANDARD.md with API review guidance:
  - Future annotations convention (#3578)
  - TypeVar naming convention (#3594)
  - Mapping vs MutableMapping (#3577)
  - Avoid shadowing built-ins (#3583)
  - Explicit exports (#3605)
  - Exception documentation guidelines (#3410)
- Simplify python/.github/instructions/python.instructions.md to reference AGENTS.md
- Remove AGENTS.md from .gitignore

* Fix purview import path in AGENTS.md

* Address PR review comments and restructure instructions

- Slim down .github/copilot-instructions.md to reference language-specific docs
- Add ADR section explaining templates and purpose
- Create dotnet/AGENTS.md with .NET-specific build commands, conventions, and sample guidance
- Update Python build/test instructions for core vs isolated changes
- Fix Microsoft.Extensions.AI package references
- Update kwargs guidance per issue #3642
- Fix Python sample helper placement (top, not bottom)
- Document new 'typing' poe task in DEV_SETUP.md

* Add 'typing' poe task to run both pyright and mypy

* Add kwargs guidelines from issue #3642 to CODING_STANDARD.md

* Clarify that connector packages pull in core as dependency

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

History

agent_framework_copilotstudio

Python: [BREAKING] Types API Review improvements (#3647 )

2026-02-04 10:13:23 +00:00

tests

Python: [BREAKING] Types API Review improvements (#3647 )

2026-02-04 10:13:23 +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

Python: Add BaseAgent implementation for Claude Agent SDK (#3509 )

2026-01-30 18:11:41 +00:00

README.md

docs: add missing pre flag (#1130 )

2025-10-02 18:50:47 +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