Microsoft Foundry
MicrosoftOfficialCreated by Microsoft
- Skill
- Workflow
- Data and AI
- MIT
- Low risk
- Has scripts
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
Microsoft Foundry provides a comprehensive framework for the entire AI agent lifecycle. This skill enables developers to scaffold, provision, deploy, and manage agents while integrating evaluation and optimization workflows. It supports various agent types, including prompt-based, managed harness, and voice agents, and provides tools for CI/CD, continuous monitoring, and fine-tuning models. The skill emphasizes a structured approach using workspace-specific metadata and standard Azure Developer CLI (azd) patterns to ensure consistent environment management and deployment.
What it does
- Scaffold and create new AI agents with support for various harness types.
- Manage the full deployment lifecycle including provisioning and CI/CD integration.
- Execute batch and continuous evaluation workflows to monitor agent quality.
- Optimize agent prompts and instructions using automated evaluation-driven loops.
- Fine-tune models using SFT, DPO, or RFT techniques with dataset curation.
- Troubleshoot agent performance through log analysis, telemetry, and trace inspection.
When to use it
- When building, deploying, or managing AI agents within the Microsoft Foundry ecosystem.
- When you need to evaluate agent performance or optimize prompts based on production traces.
- When setting up CI/CD pipelines for automated agent deployment and monitoring.
- When fine-tuning models or managing capacity and quotas for AI services.
- When troubleshooting deployment failures or agent runtime issues.
Advantages
- Provides a unified, end-to-end workflow for the entire agent development lifecycle.
- Standardizes project structure and metadata management across different environments.
- Integrates seamlessly with Azure Developer CLI (azd) for consistent infrastructure management.
- Enables data-driven improvements through automated evaluation and prompt optimization.
- Supports advanced model customization including fine-tuning and distillation.
Usage examples
- “Create a new hosted Foundry agent from scratch.”
- The agent will guide you through the quick-start workflow to scaffold, provision, and deploy a new agent project.
- “Optimize the prompt for my existing Python hosted agent.”
- The agent will trigger the evaluation-driven optimization workflow to analyze performance and suggest prompt improvements.
- “Set up a CI/CD pipeline for my agent.”
- The agent will configure the necessary deployment pipeline steps for your Foundry agent project.
- “Troubleshoot why my agent deployment is failing.”
- The agent will help you inspect logs, telemetry, and quota settings to diagnose and resolve the deployment issue.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/microsoft/microsoft-foundry/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip microsoft-foundry.zip -d .agents/skills
Documentation by Microsoft
Microsoft Foundry Skill
This skill helps developers work with Microsoft Foundry resources, covering model discovery and deployment, complete dev lifecycle of AI agent, evaluation workflows, and troubleshooting.
Pre-Execution Requirements
Follow each applicable subsection below before starting its corresponding action or workflow.
Dependency Check and Setup
MANDATORY: As the first step after this skill loads, run the dependency check and setup script below from this skill's root and wait for it to finish before continuing. The script checks first and installs only missing dependencies; it does not reinstall dependencies that are already available.
You MUST complete this check before reading or entering any sub-skill, workflow, or workflow-specific reference.
./scripts/check-and-setup-dependencies.sh # macOS / Linux
./scripts/check-and-setup-dependencies.ps1 # Windows (pwsh)Strictly follow the script output for subsequent actions.
Workflow Guidance
MANDATORY: Before executing ANY workflow-specific steps, you MUST read the corresponding sub-skill document. Do not call workflow-specific MCP tools for a workflow without reading its skill document. This applies even if you already know the MCP tool parameters — the skill document contains required workflow steps, pre-checks, and validation logic that must be followed. This rule applies on every new user message that triggers a different workflow, even if the skill is already loaded.
Foundry MCP
MANDATORY: Before using Foundry MCP operations, call the Azure MCP foundry tool and inspect the available Foundry MCP tools and related parameters. Treat this as the discovery/help step for MCP-based workflows.
azd
MANDATORY: Before executing ANY azd command, you MUST read azd-guidance and strictly follow the shared rules defined in it, especially the AZURE_DEV_USER_AGENT setting rules.
Sub-Skills
This skill includes specialized sub-skills for specific workflows. When a sub-skill matches the task, strictly follow its workflow:
| Sub-Skill | When to Use | Reference |
|---|---|---|
| deploy | Deploy hosted agents to Foundry, smoke-test a deployment, create or update prompt agents, and manage agent versions and multi-environment deploys. | deploy |
| cicd | Set up a CI/CD deployment pipeline for a Foundry agent. | cicd |
| invoke | Send messages to an agent, single or multi-turn conversations | invoke |
| routine | Schedule or event-trigger Foundry agents with routines; use azd for CRUD, enable/disable, manual dispatch, and viewing past runs, or define routines in azure.yaml. | routine |
| invocations-ws | Build, deploy, and connect to custom Hosted agents that use developer-defined duplex real-time or media streams over invocations_ws. | invocations-ws |
| observe | Evaluate agent quality, run batch evals, analyze failures, optimize prompts, improve agent instructions, compare versions, set up CI/CD monitoring, and enable continuous production evaluation | observe |
| insights | Pull generated agent insights, evidence, and recommendations from an existing monitor; read-only retrieval, not a new analysis run | insights |
| trace | Query traces, analyze latency/failures, correlate eval results to specific responses via App Insights customEvents | trace |
| troubleshoot | View hosted agent logs, query telemetry, diagnose failures | troubleshoot |
| validate | Use only when the user explicitly asks to use this validation sub-skill or to validate Microsoft Foundry hosted-agent code against best practices. Never invoke it proactively or add it to another workflow. | validate |
| create (quick start) | Create a new hosted Foundry agent from scratch end-to-end — scaffold, provision or use an existing Foundry project, deploy, and smoke-test. Do not use for any work on existing code. For anything not covered by the quickstart, use create. | create/quick-start-hosted.md |
| create | Use when the standard end-to-end happy path (quick start) doesn't fit. Create a new Foundry agent, update code of an existing agent, continue development of an existing agent, wire connections at scaffold time, use advanced setup or A2A (Agent2Agent), or recover from a failed quickstart run. | create |
| create managed harness | Create or continue developing a Prompt Agent that explicitly uses the Foundry-managed Copilot harness. Uses azd and azure.yaml, not the ordinary Prompt Agent MCP workflow. | create-managed-harness |
| create voice | Create, configure, or extend a Foundry Voice Agent, defaulting generic requests to managed Prompt Voice and supporting self-deployed Prompt Voice or two-agent Hosted Voice. | create-voice |
| agent-optimizer | Make existing Python hosted-agent code optimization-ready, configure eval.yaml, run Agent Optimizer jobs, apply candidates locally, and deploy through azd after review. | agent-optimizer |
| eval-datasets | Harvest production traces into evaluation datasets, manage dataset versions and splits, track evaluation metrics over time, detect regressions, and maintain full lineage from trace to deployment. Use for: create dataset from traces, dataset versioning, evaluation trending, regression detection, dataset comparison, eval lineage. | eval-datasets |
| project/create | Creating a new Microsoft Foundry project for hosting agents and models. Use when onboarding to Foundry or setting up new infrastructure. | project/create/create-foundry-project.md |
| resource/create | Creating Azure AI Services multi-service resource (Foundry resource) using Azure CLI. Use when manually provisioning AI Services resources with granular control. | resource/create/create-foundry-resource.md |
| private-network | Answer questions about Foundry network isolation and deploy Foundry with VNet isolation (BYO VNet, Managed VNet, hybrid). Covers architecture concepts, template selection, deployment, and post-deployment validation. | resource/private-network/private-network.md |
| models/deploy-model | Unified model deployment with intelligent routing. Handles quick preset deployments, fully customized deployments (version/SKU/capacity/RAI), and capacity discovery across regions. Routes to sub-skills: preset (quick deploy), customize (full control), capacity (find availability). | models/deploy-model/SKILL.md |
| quota | Managing quotas and capacity for Microsoft Foundry resources. Use when checking quota usage, troubleshooting deployment failures due to insufficient quota, requesting quota increases, or planning capacity. | quota/quota.md |
| rbac | Managing RBAC permissions, role assignments, managed identities, and service principals for Microsoft Foundry resources. Use for access control, auditing permissions, and CI/CD setup. | rbac/rbac.md |
| finetuning | Fine-tune models on Microsoft Foundry — SFT distillation, DPO preference optimization, RFT with graders and tool calling. Dataset preparation, grader calibration, training, checkpoint selection, deployment, evaluation. Use for: fine-tune, SFT, DPO, RFT, training data, grader, distillation, fine-tuned model, large file upload. | finetuning/SKILL.md |
| azd-guidance | Provide shared azd knowledge and guidance for managing Foundry agents. Read this first for any workflows related to azd. | azd-guidance |
💡 Tip: For a complete onboarding flow:
project/create(public) orprivate-network(VNet isolation) →models/deploy-model→ agent workflows (create→deploy→invoke).
💡 Fine-Tuning: Use
finetuningfor all model customization — SFT distillation, DPO preference optimization, and RFT with graders. Includes quickstart, grader calibration, and training curve analysis.
💡 Model Deployment: Use
models/deploy-modelfor all deployment scenarios — it intelligently routes between quick preset deployment, customized deployment with full control, and capacity discovery across regions.
💡 Prompt Optimization: For requests like "optimize my prompt" or "improve my agent instructions," load observe and use the
prompt_optimizeMCP tool through that eval-driven workflow.
Infrastructure Lifecycle
Match user intent to the correct infrastructure workflow.
| User Intent | Workflow |
|---|---|
| "Create Foundry" / "Set up Foundry" (ambiguous) | Use AskUserQuestion: (a) just an AI Services resource, (b) a project with public access, or (c) a project with network isolation? Route: (a) → resource/create, (b) → project/create, (c) → private-network |
| Set up Foundry with VNet isolation | private-network |
| Create a Foundry project (public) | project/create |
| Create a bare Foundry resource | resource/create |
Agent Development Lifecycle
Match user intent to the correct agent workflow. Read each sub-skill in order before executing.
| User Intent | Workflow (read in order) |
|---|---|
| Create or develop a Voice Agent (Prompt Voice or Hosted Voice) | dependency check and setup → azd-guidance → create-voice → deploy → invoke |
| Create or develop an explicitly requested Managed Harness Agent / Copilot harness agent | dependency check and setup → azd-guidance → create-managed-harness → deploy → invoke |
| Create a new hosted agent end-to-end (scaffold + deploy + test) | dependency check and setup → azd-guidance → quick-start-hosted (self-contained end-to-end) |
| Anything beyond the standard quickstart (existing code, migration, re-hosting, deployment customization, scaffold-time connections, A2A (Agent2Agent), recovery) | dependency check and setup → azd-guidance → create → deploy → invoke |
| Optimize existing Python hosted agent | dependency check and setup → azd-guidance → agent-optimizer → scaffold/review → eval.yaml → optimize → apply candidate → deploy → invoke |
| Deploy an agent (code already exists) | dependency check and setup → azd-guidance → deploy (includes eval-suite setup) → invoke → observe (evaluate/optimize) |
| Update/redeploy an agent after code changes | dependency check and setup → azd-guidance → deploy (includes eval-suite setup) → invoke → observe (evaluate/optimize) |
| Set up a CI/CD deployment pipeline for a hosted agent | dependency check and setup → azd-guidance → cicd |
| Invoke/test/chat with an agent | dependency check and setup → azd-guidance → invoke |
| Schedule/event-trigger an agent, or CRUD/enable/disable/dispatch a routine | dependency check and setup → azd-guidance → routine |
| Optimize / improve agent prompt or instructions | observe (Step 4: Optimize) |
| Evaluate and optimize agent (full loop) | observe |
| Enable continuous evaluation monitoring | observe (Step 6: CI/CD & Monitoring) |
| Pull agent insights / list generated issues and recommendations | dependency check and setup → insights (all pages with expanded evidence; read-only) |
| Troubleshoot an agent issue | dependency check and setup → azd-guidance → invoke → troubleshoot |
| Fix a broken agent (troubleshoot + redeploy) | dependency check and setup → azd-guidance → invoke → troubleshoot → apply fixes → deploy → invoke |
Agent: .foundry Workspace Standard
Every agent source folder can keep Foundry-specific cache and overlay state under .foundry/:
<agent-root>/
.foundry/
agent-metadata.yaml
agent-metadata.prod.yaml
suites/
datasets/
evaluators/
results/In azd projects, derive deployment context (project endpoint, agent name/version, ACR, App Insights) from
azure.yamlplusazd env get-values; do not duplicate those values in metadata when azd already provides them.agent-metadata.yamlis the preferred local/dev overlay for non-azd values, remote Foundry suite references, local cache paths, result summaries, and explicit overrides. Optional sidecar files such asagent-metadata.prod.yamlcan hold a single prod or CI-targeted overlay without mixing multiple environments in one file.suites/,datasets/, andevaluators/are local cache folders. Reuse them when they are current, and ask before refreshing or overwriting them.See Agent Metadata Contract for the canonical schema and workflow rules.
Agent: Setup References
Standard Agent Setup — advanced setup for production workloads that need data-residency control (bring-your-own Cosmos DB / Storage / AI Search via a Foundry capability host). The default
azd ai agentflow uses Basic Agent Setup and does not provisioncapabilityHosts/agents— do not flag its absence as a bug. For default post-provision state, see the "Expected env-var fingerprint" section in foundry-agent/create/create-hosted.md.
Agent: Common Project Context Resolution
Agent skills should run this step only when they need configuration values they don't already have. If a value (for example, agent root, environment, project endpoint, or agent name) is already known from the user's message or a previous skill in the same session, skip resolution for that value.
Step 1: Discover Agent Roots and azd Context
First check whether the workspace has azure.yaml with services using host: azure.ai.agent.
One azd agent service -> classify it from
kind,harness,modelType, andconversationEngine, then use that service'sprojectfolder or theazure.yamldirectory as the agent root.Multiple azd agent services -> check whether a Voice wrapper references a
kind: hostedservice viaconversationEngine.name:Selecting the Hosted Voice wrapper implies its named
kind: hostedtarget as an upstream dependency (uses: [<target>],conversationEngine.name: <target>); deploy and verification must report both services separately.Selecting the
kind: hostedtarget alone scopes changes/debugging to the target container and does not automatically modify the wrapper.Otherwise -> require the user to choose the target service/folder.
No azd agent service -> search the workspace for
.foundry/folders that containagent-metadata.yamloragent-metadata.<env>.yaml.One match -> use that agent root.
Multiple matches -> require the user to choose the target agent folder.
No matches -> for insights, ask only for missing remote inputs without initializing local files; for create/deploy workflows, seed a new
.foundry/folder during setup; for other workflows, stop and ask the user which agent source folder to initialize.
After selecting an agent root, keep all local .foundry cache inspection, source inspection, evaluator suggestions, dataset suggestions, and prompt-optimization context inside that folder only. Do not scan sibling agent folders unless the user explicitly switches roots.
Step 2: Resolve Environment and Deployment Context
If azure.yaml is present, resolve the azd environment first:
Environment explicitly named by the user
AZURE_ENV_NAMEfromazd env get-valuesazd default environment from
.azure/config.jsonEnvironment already selected earlier in the session
Run azd env get-values for the selected environment when project/deployment values are not already known. Prefer azd values for deployment context:
| azd Variable | Resolves To |
|---|---|
AZURE_AI_PROJECT_ENDPOINT or AZURE_AIPROJECT_ENDPOINT | Project endpoint |
AGENT_<SERVICE>_NAME | Agent name for the selected azd service |
AGENT_<SERVICE>_VERSION | Agent version for the selected azd service |
AZURE_CONTAINER_REGISTRY_NAME or AZURE_CONTAINER_REGISTRY_ENDPOINT | ACR registry name / image URL prefix |
APPLICATIONINSIGHTS_CONNECTION_STRING | App Insights connection string for trace workflows |
AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP, AZURE_AI_ACCOUNT_NAME, AZURE_AI_PROJECT_NAME | Azure resource lookup and Playground links |
When azd supplies these values, use them as the source of truth and do not copy them into .foundry/agent-metadata*.yaml on metadata writes.
Step 3: Select Metadata Overlay and Resolve Environment
Inside the selected agent root, choose the metadata file in this order:
Metadata filename or path explicitly provided by the user or workflow
If an explicit environment is already known and
.foundry/agent-metadata.<env>.yamlexists, use that file.foundry/agent-metadata.yamlIf multiple metadata files remain and no rule above selects one, prompt the user to choose
Read the selected metadata file and resolve any remaining environment choice in this order:
Environment explicitly named by the user
If the selected metadata file defines exactly one environment, use it
Environment already selected earlier in the session
defaultEnvironmentfrom metadata
If the selected metadata file still contains multiple environments and none of the rules above selects one, prompt the user to choose. Keep the selected agent root, metadata file, environment, and whether context came from azd or metadata visible in every workflow summary.
If the selected environment exposes older testSuites[] metadata but not evaluationSuites[], treat testSuites[] as the source for this session and normalize each entry in memory to the evaluationSuites[] shape before continuing. If the metadata is older still and only exposes legacy testCases[], normalize that list the same way. Preserve dataset and evaluator fields, keep any existing tags, and map legacy priority to tags.tier only when tags.tier is missing: P0 -> smoke, P1 -> regression, P2 -> coverage.
Step 4: Resolve eval.yaml Local Evaluation Intent
If eval.yaml exists in the selected agent root, parse it before generating new suites:
agent.name-> target agent candidate; verify it matches the selected azd/metadata agent before using it.dataset.local_uri-> local seed dataset candidate; legacydataset_filemay be normalized in memory.dataset.name/dataset.version-> registered dataset candidate.validation_dataset-> optional validation dataset candidate.evaluators[]-> candidate Foundry evaluator names; verify withevaluator_catalog_getbefore treating them as remote evaluators.name-> local eval/suite candidate; verify remotely before persisting assuiteName.options.eval_model,options.optimization_model,options.max_candidates,options.optimization_config.model_search_space,options.pass_threshold,max_samples,trace_days, andgeneration_instruction-> setup defaults.
Treat eval.yaml as local evaluation intent, not proof that a Foundry suite exists. Persist synced suite/dataset/evaluator references to .foundry only after remote lookup or registration succeeds.
Step 5: Resolve Common Configuration
Layer sources in this order:
Explicit user input and values already selected in the session
azd environment values for deployment context
.foundry/agent-metadata*.yamloverlay values and remote suite/cache referencesazure.yamlandeval.yamllocal source configurationUser prompts for anything still missing
If azd and metadata both provide the same value and they differ, stop and ask which source is authoritative. If they match, use the azd value and avoid rewriting the duplicate on future metadata writes.
| Effective Value | Preferred Source | Used By |
|---|---|---|
| Project endpoint | azd env | deploy, invoke, observe, trace, troubleshoot |
| Agent name/version | azd agent variables, then azure.yaml | invoke, observe, trace, troubleshoot |
| ACR | azd env | deploy |
| Evaluation suites and cache paths | .foundry/agent-metadata*.yaml | observe, eval-datasets |
| Local seed dataset/evaluator intent | eval.yaml | observe, eval-datasets |
Step 6: Write Metadata Overlay (Create/Deploy/Observe Only)
On any metadata write (deploy, auto-setup, dataset refresh, or trace-to-dataset update), persist only non-derivable overlay/cache state in the selected metadata file:
azd binding (
azd.environmentName,azd.service) when useful for future resolutionevaluationSuites[]with remote suite/dataset/evaluator references and local cache pathslastEval, result files, comparison summaries, or explicit non-azd overrides
Do not copy azd-owned deployment values into metadata when azd already provides them. If the selected file is a preferred single-environment file, rewrite only that one environment block. If the selected file is a legacy multi-environment file, rewrite only the selected environment block. Never copy or merge environments across sibling metadata files automatically. If the selected environment still uses older testSuites[] or legacy testCases[], rewrite it to evaluationSuites[] and remove migrated priority fields from the rewritten entries.
Step 7: Collect Missing Values
Use the ask_user or askQuestions tool only for values not resolved from the user's message, session context, metadata, or azd bootstrap. Common values skills may need:
Agent root — Target azd service project folder or folder containing
.foundry/agent-metadata*.yamlMetadata file —
agent-metadata.yamlfor local/dev, or an explicit sidecar such asagent-metadata.prod.yamlEnvironment — azd environment,
dev,prod, or another environment key from metadataProject endpoint — Microsoft Foundry project endpoint URL
Agent name — Name of the target agent
💡 Tip: If the user already provides the agent path, environment, project endpoint, or agent name, extract it directly — do not ask again.
Agent: Agent Types
Agent workflows distinguish four first-class agent types:
| Type | Kind | Description |
|---|---|---|
| Prompt | "prompt" | LLM-based agents backed by a model deployment; managed via Foundry MCP or SDK |
| Hosted | "hosted" | Container-based agents running custom code; developed and deployed via azd |
| Managed Harness Agent | "prompt" with harness.type: "microsoft_copilot_preview" for new authoring | Prompt Agent running on the Foundry-managed Copilot harness; developed and deployed via azd |
| Voice | "voice" | Managed real-time Voice Agent — either Prompt Voice (1 agent, modelType: managed or self_deployed) or Hosted Voice (2 agents: kind: voice wrapper with conversationEngine.type: hosted_agent + kind: hosted target over invocations_ws 1.0.0 and Voice Live Bridge 1.0); developed and deployed via azd and verified over the voice WebSocket endpoint |
Classify an azure.yaml service by its definition in this exact order, not by host alone:
kind: voice-> Voice. For compatibility, silently classify an existingkind: prompt-voiceservice as Voice, then normalize it when editing its YAML. Classify the subtype:conversationEngine.type: hosted_agent-> Hosted Voice wrapper (paired with a namedkind: hostedtarget service).modelType: managedormodelType: self_deployed-> Prompt Voice (Foundry infers native speech-to-speech vs cascaded STT -> LLM -> TTS frommodel.id).Having both
modelType/modelandconversationEngineis invalid (stop and fixazure.yaml); having neither is incomplete (do not guess). Never use obsoletemodelType: hosted_agent,targetAgent, or a nestedconfig:block.
kind: hosted-> Hosted. When it declaresprotocols: [{ protocol: invocations_ws, version: 1.0.0 }]andmetadata.voiceLiveCompatible: "true"alongside akind: voicewrapper, it is a Hosted Voice target; otherwise treat a standaloneinvocations_wsservice as a custom Hosted real-time/audio agent.kind: promptplusharness.type: microsoft_copilot_previewor legacygithub_copilot_preview-> Managed Harness Agent.kind: promptwithout that harness -> ordinary Prompt Agent.
Use agent_get only when the type cannot be resolved from project context. Preserve the harness discriminator already authored on an existing Managed Harness Agent; do not migrate it during ordinary edits or redeploys. Do not convert an existing Agent between Prompt, Hosted, Managed Harness Agent, and Voice types; create a new Agent instead. Before creating any Voice Agent, determine the model strategy first per create-voice.
Tool Usage Conventions
Use the
ask_useroraskQuestionstool whenever collecting information from the userUse the
taskorrunSubagenttool to delegate long-running or independent sub-tasks (e.g., env var scanning, status polling, Dockerfile generation)Prefer azd for Hosted Agents, Managed Harness Agents, and Voice Agents; prefer Foundry MCP for ordinary Prompt Agents.
Reference official Microsoft documentation URLs instead of embedding CLI command syntax
Azure Authentication
Additional Resources
Network Isolation Errors
Applies to any call against a Foundry project or its parent Foundry account — Foundry MCP tools, azd, az CLI, curl, REST, or SDK.
If an error matches Public access is disabled / PublicNetworkAccessDisabled / 403 Forbidden from a private endpoint / connection timeout / the project endpoint FQDN resolves to a public IP, this typically means the parent Foundry account has publicNetworkAccess=Disabled or Enabled from selected IP addresses, and the current shell is outside its VNet.
Only if the error is ambiguous, confirm against the Foundry account using a management-plane call (works from anywhere with reader access):
az cognitiveservices account show \
--name <account> --resource-group <rg> \
--query "properties.{publicNetworkAccess:publicNetworkAccess, networkAcls:networkAcls, privateEndpointConnections:privateEndpointConnections[].properties.privateLinkServiceConnectionState.status}"publicNetworkAccess: "Disabled" — or "Enabled" together with non-empty networkAcls.ipRules / virtualNetworkRules — confirms isolation. If publicNetworkAccess: "Enabled" and networkAcls is empty, the failure is a caller-side network issue (e.g. Private DNS resolving the FQDN to a public IP from inside a VNet with a private endpoint), not an account-config issue.
If it's indeed a network isolation issue, supported connection options are documented in Choose a secure connection method to Foundry.
ℹ️ Foundry MCP tools cannot reach a VNet-isolated project even from inside the VNet.
Files
- .gitignore0 B
- ATTRIBUTION.mdAdded by AutoGineer983 B
- LICENSELicence file added by AutoGineer1.1 KiB
- SKILL.md30.4 KiB
- foundry-agent/agent-optimizer/agent-optimizer.md3.3 KiB
- foundry-agent/agent-optimizer/references/azd-setup.md1.2 KiB
- foundry-agent/agent-optimizer/references/eval-yaml.md3.2 KiB
- foundry-agent/agent-optimizer/references/optimize-workflow.md2.1 KiB
- foundry-agent/agent-optimizer/references/python-patterns.md4.0 KiB
- foundry-agent/agent-optimizer/references/scaffold.md3.3 KiB
- foundry-agent/azd-guidance/azd-guidance.md1.2 KiB
- foundry-agent/azd-guidance/references/azd-ai-cli.md10.3 KiB
- foundry-agent/cicd/cicd.md301 B
- foundry-agent/create/create-hosted.md33.8 KiB
- foundry-agent/create/create-managed-harness.md7.2 KiB
- foundry-agent/create/create-prompt.md4.6 KiB
- foundry-agent/create/create-voice.md13.1 KiB
- foundry-agent/create/quick-start-hosted.md23.6 KiB
- foundry-agent/create/references/enable-incoming-a2a.md3.7 KiB
- foundry-agent/create/references/foundry-model.md1.6 KiB
- foundry-agent/create/references/foundry-tool-catalog.md42.9 KiB
- foundry-agent/create/references/guardrails/guardrail-api-create.md3.8 KiB
- foundry-agent/create/references/guardrails/guardrail-attach.md3.8 KiB
- foundry-agent/create/references/guardrails/guardrail-manage.md2.1 KiB
- foundry-agent/create/references/hosted-voice-yaml.md1.7 KiB
- foundry-agent/create/references/langchain-langgraph-hosting.md2.2 KiB
- foundry-agent/create/references/local-run.md11.5 KiB
- foundry-agent/create/references/managed-harness-agent.md3.5 KiB
- foundry-agent/create/references/re-host.md2.6 KiB
- foundry-agent/create/references/sdk-operations.md2.2 KiB
- foundry-agent/create/references/skills/managed-harness-agent-skill-attach.md1.3 KiB
- foundry-agent/create/references/skills/skill-attach.md7.0 KiB
- foundry-agent/create/references/skills/skill-manage.md5.4 KiB
- foundry-agent/create/references/skills/skill-toolbox-attach.md5.1 KiB
- foundry-agent/create/references/tools/managed-harness-agent/agent-tools.md1.8 KiB
- foundry-agent/create/references/tools/managed-harness-agent/tool-a2a.md1.1 KiB
- foundry-agent/create/references/tools/managed-harness-agent/tool-azure-ai-search.md1.2 KiB
- foundry-agent/create/references/tools/managed-harness-agent/tool-code-interpreter.md391 B
- foundry-agent/create/references/tools/managed-harness-agent/tool-fabric-iq.md1.1 KiB
- foundry-agent/create/references/tools/managed-harness-agent/tool-file-search.md526 B
- foundry-agent/create/references/tools/managed-harness-agent/tool-github-copilot-toolset.md1.2 KiB
- foundry-agent/create/references/tools/managed-harness-agent/tool-mcp.md1.7 KiB
- foundry-agent/create/references/tools/managed-harness-agent/tool-openapi.md1.2 KiB
- foundry-agent/create/references/tools/managed-harness-agent/tool-toolbox.md2.1 KiB
- foundry-agent/create/references/tools/managed-harness-agent/tool-web-search.md387 B
- foundry-agent/create/references/tools/managed-harness-agent/tool-work-iq.md1.3 KiB
- foundry-agent/create/references/tools/prompt-agent/agent-tools.md4.5 KiB
- foundry-agent/create/references/tools/prompt-agent/tool-a2a.md675 B
- foundry-agent/create/references/tools/prompt-agent/tool-azure-ai-search.md3.3 KiB
- foundry-agent/create/references/tools/prompt-agent/tool-bing-grounding.md2.8 KiB
- foundry-agent/create/references/tools/prompt-agent/tool-code-interpreter.md1.0 KiB
- foundry-agent/create/references/tools/prompt-agent/tool-fabric-iq.md1.9 KiB
- foundry-agent/create/references/tools/prompt-agent/tool-file-search.md2.6 KiB
- foundry-agent/create/references/tools/prompt-agent/tool-function-calling.md842 B
- foundry-agent/create/references/tools/prompt-agent/tool-mcp.md3.4 KiB
- foundry-agent/create/references/tools/prompt-agent/tool-memory.md4.8 KiB
- foundry-agent/create/references/tools/prompt-agent/tool-openapi.md1.5 KiB
- foundry-agent/create/references/tools/prompt-agent/tool-web-search.md3.6 KiB
- foundry-agent/create/references/tools/prompt-agent/tool-work-iq.md1.7 KiB
- foundry-agent/create/references/use-toolbox-in-hosted-agent.md10.4 KiB
- foundry-agent/create/references/voice-agent-common.md1.6 KiB
- foundry-agent/create/references/voice-agent-hosted-bridge.md8.1 KiB
- foundry-agent/create/references/voice-agent-prompt-yaml.md3.9 KiB
- foundry-agent/create/references/voice-agent-settings.md5.8 KiB
- foundry-agent/create/references/voice-agent-smoke-test.md7.8 KiB
- foundry-agent/create/scripts/check-copilot-app-entry.ps1Script5.5 KiB
- foundry-agent/create/scripts/check-copilot-app-entry.shScript4.2 KiB
- foundry-agent/create/scripts/resolve-project-id.ps1Script5.8 KiB
- foundry-agent/create/scripts/resolve-project-id.shScript9.0 KiB
- foundry-agent/create/scripts/smoke-test-voice.ps1Script2.6 KiB
- foundry-agent/create/scripts/smoke-test-voice.shScript966 B
- foundry-agent/create/scripts/smoke_test_voice.pyScript14.5 KiB
- foundry-agent/create/scripts/verify-environment.ps1Script8.2 KiB
- foundry-agent/create/scripts/verify-environment.shScript6.5 KiB
- foundry-agent/deploy/deploy.md25.7 KiB
- foundry-agent/deploy/references/container-deploy.md2.1 KiB
- foundry-agent/deploy/references/voice-deploy.md2.2 KiB
- foundry-agent/eval-datasets/eval-datasets.md11.2 KiB
- foundry-agent/eval-datasets/references/dataset-comparison.md4.7 KiB
- foundry-agent/eval-datasets/references/dataset-curation.md4.1 KiB
- foundry-agent/eval-datasets/references/dataset-organization.md4.7 KiB
- foundry-agent/eval-datasets/references/dataset-versioning.md7.3 KiB
- foundry-agent/eval-datasets/references/eval-lineage.md4.0 KiB
- foundry-agent/eval-datasets/references/eval-regression.md6.9 KiB
- foundry-agent/eval-datasets/references/eval-trending.md4.8 KiB
- foundry-agent/eval-datasets/references/generate-seed-dataset.md8.7 KiB
- foundry-agent/eval-datasets/references/trace-to-dataset.md17.0 KiB
- foundry-agent/insights/insights.md4.5 KiB
- foundry-agent/insights/references/tool-contract.md3.4 KiB
- foundry-agent/invocations-ws/invocations-ws.md10.4 KiB
- foundry-agent/invocations-ws/references/invocations-ws-protocol.md7.8 KiB
- foundry-agent/invoke/invoke.md11.8 KiB
- foundry-agent/invoke/references/file-operations.md2.8 KiB
- foundry-agent/invoke/references/invocations-protocol.md3.4 KiB
- foundry-agent/invoke/references/session-management.md3.6 KiB
- foundry-agent/observe/observe.md15.3 KiB
- foundry-agent/observe/references/analyze-results.md6.3 KiB
- foundry-agent/observe/references/cicd-monitoring.md3.6 KiB
- foundry-agent/observe/references/compare-iterate.md3.3 KiB
- foundry-agent/observe/references/continuous-eval.md15.1 KiB
- foundry-agent/observe/references/deploy-and-setup.md5.5 KiB
- foundry-agent/observe/references/evaluate-step.md8.5 KiB
- foundry-agent/observe/references/evaluation-suite-generation.md12.3 KiB
- foundry-agent/observe/references/optimize-deploy.md1.5 KiB
- foundry-agent/routine/references/azure-yaml.md2.6 KiB
- foundry-agent/routine/references/cli-crud.md6.0 KiB
- foundry-agent/routine/routine.md8.0 KiB
- foundry-agent/toolbox/references/mcp-protocol.md3.2 KiB
- foundry-agent/toolbox/references/test-endpoint.md6.4 KiB
- foundry-agent/toolbox/references/tool-a2a.md2.2 KiB
- foundry-agent/toolbox/references/tool-azure-ai-search.md7.0 KiB
- foundry-agent/toolbox/references/tool-browser-automation.md3.5 KiB
- foundry-agent/toolbox/references/tool-code-interpreter.md3.5 KiB
- foundry-agent/toolbox/references/tool-fabric-iq.md4.4 KiB
- foundry-agent/toolbox/references/tool-file-search.md4.1 KiB
- foundry-agent/toolbox/references/tool-mcp-agent-identity.md7.8 KiB
- foundry-agent/toolbox/references/tool-mcp-custom-oauth-azure-starter.md4.0 KiB
- foundry-agent/toolbox/references/tool-mcp-custom-oauth.md7.9 KiB
- foundry-agent/toolbox/references/tool-mcp-key-auth.md4.2 KiB
- foundry-agent/toolbox/references/tool-mcp-managed-oauth.md6.3 KiB
- foundry-agent/toolbox/references/tool-mcp-noauth.md3.9 KiB
- foundry-agent/toolbox/references/tool-mcp-user-entra-token.md5.2 KiB
- foundry-agent/toolbox/references/tool-openapi.md6.2 KiB
- foundry-agent/toolbox/references/tool-tool-search.md5.9 KiB
- foundry-agent/toolbox/references/tool-web-search.md3.1 KiB
- foundry-agent/toolbox/references/tool-work-iq.md7.6 KiB
- foundry-agent/toolbox/references/toolbox-azd.md6.1 KiB
- foundry-agent/toolbox/scripts/get-catalog-inputs.ps1Script12.7 KiB
- foundry-agent/toolbox/scripts/get-catalog-inputs.shScript13.0 KiB
- foundry-agent/toolbox/toolbox.md7.8 KiB
- foundry-agent/trace/references/analyze-failures.md3.9 KiB
- foundry-agent/trace/references/analyze-latency.md3.8 KiB
- foundry-agent/trace/references/conversation-detail.md3.7 KiB
- foundry-agent/trace/references/eval-correlation.md2.5 KiB
- foundry-agent/trace/references/kql-templates.md10.6 KiB
- foundry-agent/trace/references/search-traces.md6.8 KiB
- foundry-agent/trace/trace.md6.5 KiB
- foundry-agent/troubleshoot/troubleshoot.md8.7 KiB
- foundry-agent/validate/references/default-rules.yaml18.1 KiB
- foundry-agent/validate/references/report-schema.json3.3 KiB
- foundry-agent/validate/references/report-template.md.tpl2.8 KiB
- foundry-agent/validate/references/rules-schema.json2.5 KiB
- foundry-agent/validate/validate.md7.4 KiB
- project/connections.md3.1 KiB
- project/create/create-foundry-project.md8.4 KiB
- quota/quota.md9.0 KiB
- quota/references/capacity-planning.md8.2 KiB
- quota/references/error-resolution.md4.9 KiB
- quota/references/optimization.md7.6 KiB
- quota/references/ptu-guide.md6.2 KiB
- quota/references/troubleshooting.md7.3 KiB
- quota/references/workflows.md6.9 KiB
- rbac/rbac.md7.1 KiB
- references/agent-metadata-contract.md8.7 KiB
- references/auth-best-practices.md6.5 KiB
- references/standard-agent-setup.md4.2 KiB
- resource/create/create-foundry-resource.md6.1 KiB
- resource/create/references/patterns.md3.9 KiB
- resource/create/references/troubleshooting.md2.4 KiB
- resource/create/references/workflows.md6.7 KiB
- resource/private-network/private-network.md6.3 KiB
- resource/private-network/references/custom-template-adaptation.md1.6 KiB
- resource/private-network/references/deploy.md3.7 KiB
- resource/private-network/references/end-to-end-test.md4.1 KiB
- resource/private-network/references/intake.md6.5 KiB
- resource/private-network/references/post-deployment-validation.md3.7 KiB
- resource/private-network/references/scaffold.md1.7 KiB
- resource/private-network/references/template-index.md1.6 KiB
- resource/private-network/references/vpn-dns-setup.bicep4.5 KiB
- resource/private-network/references/vpn-dns-setup.md6.4 KiB
- scripts/check-and-setup-dependencies.ps1Script1.2 KiB
- scripts/check-and-setup-dependencies.shScript845 B
foundry-agent/create/references/local-run.md
Local Run Reference
Use this when iterating on a hosted agent before deploying.
Prerequisite: Local run does NOT require
azd provisionor any deployed Azure infrastructure. The agent runs on your machine and calls the Foundry model endpoint directly using your local credentials (DefaultAzureCredential— falls back toaz login/ VS Code identity). You only need a.envfile in the agent directory with:FOUNDRY_PROJECT_ENDPOINT=https://<account>.services.ai.azure.com/api/projects/<project> AZURE_AI_MODEL_DEPLOYMENT_NAME=<model-deployment-name>If you already ran
azd provision, extract these fromazd env get-values.🚦 If no project endpoint is configured (not in the message,
azd env, or.env) and the user hasn't asked to create one, stop and ask them to pick an existing project or confirm creating a new one — don't silently select orazd provisionone. Once they choose, follow deploy.md Step 2 to provision or resolve the project, then return here for local iteration before deploying the agent.Critical: keep
.envandazd envin sync.azd ai agent runinjects the activeazd envvalues into the agent process before Python loads.env. Many samples useload_dotenv(override=False), so an existing process environment value wins over.env. If you change the project endpoint or model deployment, update both.envandazd env:azd env set FOUNDRY_PROJECT_ENDPOINT "https://<account>.services.ai.azure.com/api/projects/<project>" azd env set AZURE_AI_MODEL_DEPLOYMENT_NAME "<model-deployment-name>" azd env get-valuesA stale
AZURE_AI_MODEL_DEPLOYMENT_NAMEinazd envcan make local run call the wrong deployment even when.envis correct, commonly surfacing as a Foundry responses API404 Not Found.
Prepare the local environment
For Python agents, prepare the environment from the agent's service source directory -- the folder that contains pyproject.toml / requirements.txt and the agent source (typically <repo>/src/<service-name>/, not the azd project root). azd ai agent run resolves the venv relative to this folder; a .venv created in the project root is ignored and azd silently creates a second one without uv.
cdinto the service source directory.Create a venv, for example
python -m venv .venv.Activate the venv.
Install
uvinside the active venv:python -m pip install uv.In the same shell with the service-dir
.venvactivated, runazd ai agent run --no-client(from any cwd in the project); it installspyproject.toml/requirements.txtdependencies itself and usesuvfrom the active venv for faster Python dependency installation.
Important: The venv must live next to
pyproject.toml/requirements.txt, not in the azd project root. Installuvbefore runningazd ai agent run, and keep that venv activated when running the command; otherwise the local run falls back to slower dependency installation. Do NOT manually runpip install -r requirements.txt/uv pip install -r requirements.txt --prerelease=allow; letazd ai agent runinstall dependencies.
Start the agent locally
The examples below use the default port 8088. Confirm it is free; if occupied, choose another port and add the same --port <n> to both run and invoke --local. Activate the service-dir .venv, then in that venv run:
azd ai agent run --no-clientUse --no-client without prompting unless the user explicitly requests a local client UI. If a client is requested, omit the flag.
What this does:
Resolves the agent service from
azure.yaml(auto-picks when only one exists).Detects the project type (Python, .NET, or Node.js) from files in the service source dir.
Installs dependencies if needed. For Python,
azd ai agent runinstallspyproject.toml/requirements.txtdependencies itself and usesuvfrom the active local environment when available.Starts the agent in the foreground on
localhost:8088(default).Opens no client when
--no-clientis set. Without that flag, azd opens Agent Inspector for the Responses and Invocations protocols, and Microsoft 365 Agents Playground for the Activity protocol.
Readiness gate — required before local invocation.
Start checking TCP connections to
localhost:<port>immediately after launching the agent in the background; retry failed connections every 2–5 seconds.In the same loop, check whether the
azd ai agent runprocess has exited. If it exited, stop polling immediately, read its output, and fix that specific cause (for example, a dependency install failure) before restarting.Keep each startup wait at 5 seconds or less, including sleeps and shell-tool output reads.
Proceed to the smoke invocation as soon as TCP connects, keeping the server running.
If the startup timeout expires before a connection succeeds, inspect the server logs and resolve the cause before retrying.
Ctrl+C stops the agent and clears the saved local session id in an interactive terminal.
For headless or CI runs, pass --no-client and start the local server in a managed background session that later steps can monitor and stop. Once the readiness check passes, invoke it from a second command when the service exposes the Responses or Invocations protocol, then stop the same background session before deploying or leaving a temporary workspace. For an Activity-only service, headless local run validates startup only; azd ai agent invoke cannot perform the Activity round trip.
Do not start azd ai agent run as a detached process that you cannot monitor or stop (for example, a bare azd ai agent run ... &, or a popped PowerShell window on Windows). Keep logs, readiness polling, and the PID/process handle for cleanup.
Activity protocol
To invoke Activity locally through Microsoft 365 Agents Playground, omit --no-client:
azd ai agent runazd opens Microsoft 365 Agents Playground for Activity traffic. If Activity coexists with another protocol, invoke each requested protocol through its own client path.
Voice Agents and Hosted Voice targets (invocations_ws + Bridge 1.0)
Prompt Voice Agents have no local container runtime. Skip local run and deploy to Azure, then verify over the managed
voiceWebSocket endpoint (see voice-agent-smoke-test.md).Hosted Voice targets (
kind: hostedwithprotocols: [{ protocol: invocations_ws, version: 1.0.0 }]andmetadata.voiceLiveCompatible: "true") exposews://127.0.0.1:8088/invocations_wsandGET /readinesslocally instead of HTTPresponses/invocations. Start the target locally (uv run --no-sync python main.pyorazd ai agent run <target-service> --no-client) and runscripts/smoke_test.py(session.startwithprotocol_version: "1.0"->session.ready,user.messagewith"/help"->response.created->response.output_text.done->response.done) before deploying (see voice-agent-hosted-bridge.md).Local target testing validates only the Hosted target's Bridge
1.0handler, not the managed Foundry Voice audio pipeline (kind: voicewrapper), which must be smoke-tested after deployment.
Useful flags
| Flag | Purpose |
|---|---|
--port <n> / -p <n> | Override the listen port. Useful when 8088 is taken. |
--start-command "<cmd>" / -c "<cmd>" | Override azure.yaml and auto-detect. Example: --start-command "python app.py". |
--no-client | Skip the local client UI. Use by default unless the user requests a client UI. |
Pass the service name when there are multiple ai.agent services:
azd ai agent run my-agent --no-client
azd ai agent run my-activity-agentWhere the start command comes from
Resolution order (first non-empty wins):
--start-commandflag.azure.yaml services.<name>.startupCommand.Auto-detected from project type.
Example:
# azure.yaml
services:
my-agent:
project: src/my-agent
language: python
host: azure.ai.agent
startupCommand: "uvicorn app:app --host 0.0.0.0 --port 4001"If detection fails and no override is set, run errors with the project dir and asks for --start-command or startupCommand.
Invoke the local agent
azd ai agent invoke --local "<short representative prompt for the agent's purpose>"For a multi-agent project, select the service explicitly:
azd ai agent invoke my-agent --local "<short representative prompt for the agent's purpose>"Prefer the named form when multiple agent services exist. Keep the unnamed form for a single-agent project.
Do not use --output json with invoke. The invoke command supports default and raw output only.
Run one representative local invocation before deploying. If the local invocation returns a model 404 or wrong deployment error, check azd env get-values before changing code; stale azd env values are the most common cause.
--local differs from a remote invoke in:
Targets
http://localhost:<port>instead of the Foundry endpoint.Targets localhost, so it does not authorize or bill a remote invocation.
--versionis rejected (versions are a remote concept).A name selects the intended service in a multi-agent project.
Other useful flags:
| Flag | Purpose |
|---|---|
--protocol responses (default) / --protocol invocations | Wire format your agent speaks. |
--input-file request.json / -f request.json | Send a file body instead of a string message. |
--new-session | Drop the saved local session and start fresh. |
--port <n> | Match the port you started run with. |
After the local invocation completes, stop the azd ai agent run process you started before moving on.
For the Activity protocol, azd ai agent invoke --local is not supported; use Microsoft 365 Agents Playground instead.
When to graduate to remote
Local dev validates code shape; remote validates infra + identity + Foundry binding. Move to deploy when:
You changed the agent's
model,tools,connections, orprotocolsinazure.yaml. Those only take effect on the deployed agent.You need to test against real Foundry connections (search indexes, Bing, MCP, A2A) that have no local mock.
You are ready to publish a new immutable agent version.
Before proceeding to deploy, clean up the local agent process.
Next step -> deploy/deploy.md.
Common failures
| Symptom | Likely cause | Fix |
|---|---|---|
could not connect to localhost:<port> | run not started, or wrong port | Start azd ai agent run --no-client; pass --port to invoke --local if non-default. |
could not detect project type in <dir> | Missing project marker file | Set startupCommand in azure.yaml or pass --start-command. |
cannot use --version with --local | --version is remote-only | Drop --version, or remove --local to hit the deployed agent. |
Older command uses --no-inspector | Deprecated compatibility alias | Replace it with --no-client. |
| Requested client never opens | Agent Inspector is missing or localhost not ready | For the Responses or Invocations protocol, install Agent Inspector with azd extension install azure.ai.inspector, then run without --no-client. |
| Auth / connection errors against Azure services | Local credentials not wired | Expected -- DefaultAzureCredential falls back to your az login / VS Code identity. Use azd auth login if needed. |
Requirements and compatibility
Written for: Claude Code
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Names Claude Code tools, Needs a command-line tool, Needs Python
Security
What our scanner noticed· Low risk
- Phrasing that asks for actions without confirmation
- Instructions that use the network
- Scripts that your agent may run
This skill includes scripts that your agent may run. Read them before you use it.
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Created by
- Microsoft
- Publisher
- Microsoft (Official)
- Source
- microsoft/skills · .github/plugins/azure-skills/skills/microsoft-foundry · commit 0696600
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from .github/plugins/azure-skills/LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
- Also distributed in
- microsoft/azure-skills
AutoGineer is not affiliated with or endorsed by Microsoft or Microsoft.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download microsoft-foundry.zip