Declarative Agent Developer
MicrosoftOfficialPublished by Microsoft
- Skill
- Tool integration
- Software development
- MIT
- Low risk
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
The declarative-agent-developer skill provides a structured workflow for managing the lifecycle of M365 Copilot and Teams declarative agents. It utilizes the M365 Agent Toolkit (ATK) CLI to handle project scaffolding, manifest management, API plugin integration, and deployment. The skill enforces strict workspace validation, requiring specific project structures before allowing modifications, and provides standardized protocols for error handling, localization, and authentication configuration.
What it does
- Scaffolds new declarative agent projects using the ATK CLI.
- Manages and validates declarativeAgent.json manifests.
- Integrates API plugins and MCP servers into existing agent projects.
- Configures OAuth authentication for secure plugin communication.
- Handles localization of agent manifests and language files.
- Deploys agents to local environments for testing and validation.
When to use it
- When creating a new declarative agent project for M365 Copilot or Teams.
- When adding new capabilities, API plugins, or MCP servers to an existing agent.
- When updating agent instructions or conversation starters.
- When localizing an agent for multiple languages.
- When troubleshooting or fixing errors in an agent manifest.
Advantages
- Ensures consistent project structure through mandatory workspace checks.
- Automates complex tasks like API plugin registration and OAuth setup.
- Provides a clear, step-by-step protocol for error detection and resolution.
- Facilitates standardized deployment and testing workflows.
- Maintains schema compatibility by checking version requirements before feature implementation.
Usage examples
- “Create a new declarative agent project.”
- The agent will initialize a new project structure, including the necessary manifest files, provided the workspace is empty and valid for agent development.
- “Add an API plugin to my agent using this OpenAPI spec URL.”
- The agent will use the ATK CLI to integrate the specified API, map the requested operations, and prompt for necessary metadata updates.
- “Localize my agent into French.”
- The agent will generate the required tokenized manifests and language files to support French localization.
- “Deploy my agent to the local environment.”
- The agent will run the provisioning command and provide the M365 test link for the deployed agent.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/microsoft/declarative-agent-developer/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip declarative-agent-developer.zip -d .agents/skills
Documentation by Microsoft
M365 Agent Developer
Telemetry Tagging
Before running any atk CLI commands, set the session environment variable so all CLI invocations are tagged as skill-initiated:
export ATK_CLI_SKILL=trueRun this once at the start of the session. All subsequent atk commands in the same terminal will inherit it.
⛔ Workspace Check — MANDATORY FIRST STEP
Before doing ANYTHING, check the workspace files to fingerprint the project:
Run
npx -y --package @microsoft/m365agentstoolkit-cli atk --versionto confirm ATK CLI is installed. If not found → Stop. Tell the user to install ATK.Check for
m365agents.ymlorteamsApp.ymlat the project root.Check for
appPackage/declarativeAgent.json.Check for non-agent indicators (
package.jsonwith express/react/next,src/index.js,app.py, etc.)
Then follow the decision gate:
| Condition | Gate | Action |
|---|---|---|
Non-agent project files, no appPackage/ | Reject | Text-only response. No files, no commands. |
| No manifest, user wants to edit/deploy | Reject | Text-only response. Explain manifest is missing. |
| No manifest, user wants new project | Scaffold | → Scaffolding Workflow |
| Manifest exists with errors | Fix | Detect → Inform → Ask (see below). Do NOT deploy. |
| Valid project, user reports behavior issues | Review | → Instruction Review — run the full 5-phase review workflow |
| Valid agent project | Edit | → Editing Workflow |
Detailed gate rules, examples, and anti-patterns: Workspace Gates
🚫 HARD REJECTION RULES — No Exceptions
These rules override ALL other instructions. If any of these apply, you MUST stop immediately.
NEVER create
declarativeAgent.jsonyourself. If the manifest is missing and the user asked to edit/modify/deploy, respond with text only: explain the manifest is missing, suggestnpx -y --package @microsoft/m365agentstoolkit-cli atk newor starting from scratch. Do NOT create the file, do NOT createappPackage/, do NOT "help" by scaffolding implicitly.NEVER create files in a non-agent project. If the workspace is an Express/React/Django/etc. app without
appPackage/, your response must be text-only. Do NOT create any files, do NOT run any commands.NEVER deploy when errors exist. If the agent manifest has errors, STOP. Do NOT run
npx -y --package @microsoft/m365agentstoolkit-cli atk provision— not "to test", not "to demonstrate the error", not "to see what happens". Report the errors and ask the user how to proceed.
🔍 Detect → Inform → Ask (Error-Handling Protocol)
When you encounter ANY problem (missing files, malformed JSON, validation errors, incompatible features), you MUST follow this sequence in order:
Detect — Identify the specific problem. For JSON issues, attempt to parse the file and report syntax errors. For missing fields, check the manifest against the Schema.
Inform — Tell the user BEFORE taking any action. Describe exactly what is wrong ("declarativeAgent.json has malformed JSON: missing comma on line 12, unclosed array on line 18").
Ask — Wait for the user's response before making changes. Do NOT silently fix, auto-correct, or work around the problem.
This protocol applies to:
Missing
declarativeAgent.json→ Detect (file not found) → Inform ("no manifest found") → Ask ("would you like to create a new agent?")Malformed JSON → Detect (parse errors) → Inform (list specific syntax issues) → Ask ("should I fix these syntax errors?")
Validation errors → Detect (parse and check manifest) → Inform (list all errors) → Ask ("how would you like to fix these?")
Version incompatibility → Detect (feature requires newer version) → Inform ("this feature requires v1.6, your agent is v1.4") → Ask ("should I upgrade?")
Phase Routing
| Scenario | Workflow Reference |
|---|---|
| Creating a NEW project from scratch | Scaffolding Workflow |
Working with existing .json manifests | Editing Workflow |
| Adding an API plugin | API Plugins |
| Adding an MCP server | MCP Plugin |
| Adding OAuth to an MCP or API plugin | Authentication |
| Reviewing or improving existing agent instructions | Instruction Review |
| User reports agent gives generic/wrong answers | Instruction Review |
| Localizing an agent into multiple languages | Localization |
| Adding a new language to an already-localized agent | Localization |
| Writing agent instructions | Conversation Design |
ATK CLI Setup
Before running any ATK commands, check if the ATK CLI is available by running npx -y --package @microsoft/m365agentstoolkit-cli atk --version. If not found, STOP and tell the user — do NOT attempt to install it yourself.
All commands use the npx -y --package @microsoft/m365agentstoolkit-cli atk prefix (e.g., npx -y --package @microsoft/m365agentstoolkit-cli atk provision --env local).
Critical Rules
1. Deploy After EVERY Edit
After ANY change to files in appPackage/, you MUST deploy and show the test link before responding:
npx -y --package @microsoft/m365agentstoolkit-cli atk provision --env local --interactive falseThen read M365_TITLE_ID from env/.env.local and ALWAYS present the review UX:
✅ Agent deployed successfully!
🚀 Test Your Agent in M365 Copilot:
🔗 https://m365.cloud.microsoft/chat/?titleId={M365_TITLE_ID}⛔ Never respond without this link. If you deployed, the test link MUST appear in your response. This is not optional — it is how the user tests their agent.
If the manifest has errors → STOP. Fix errors. Do NOT deploy.
Exception: user explicitly asks you not to deploy
2. Never Invent Content or Create Missing Files
Do NOT invent placeholder names, descriptions, or instructions
Do NOT create
declarativeAgent.jsonorappPackage/if they don't exist — this is a REJECT scenario, not a "help by creating" scenarioIf required fields are missing, report the gaps, and ASK the user
If JSON is malformed, follow Detect → Inform → Ask: parse the file first, tell the user what's broken, then ask before fixing. Use surgical edits (not rewrites)
⛔ NEVER set placeholder values for environment variables that are populated by automation (e.g.,
<PREFIX>_MCP_AUTH_ID,TEAMS_APP_ID). Leave them empty (VAR_NAME=). Placeholders will be treated as real values and will NOT be overwritten by provisioning.
3. Schema Version Compatibility
Before adding ANY feature, read the version field in declarativeAgent.json and check the Schema feature matrix. If the feature isn't supported in that version, refuse and offer to upgrade.
Key version gates:
sensitivity_label,worker_agents,EmbeddedKnowledge→ v1.6 onlyMeetings→ v1.5+ScenarioModels,behavior_overrides,disclaimer→ v1.4+Dataverse,TeamsMessages,Email,People→ v1.3+
4. Use npx -y --package @microsoft/m365agentstoolkit-cli atk add action for API Plugins — NEVER Create Plugin Files Manually
You are forbidden from manually creating ai-plugin.json, OpenAPI specs, adaptive cards, or editing the actions array. Use the CLI:
# ⛔ Always list ALL operations in a single call — NEVER run separate calls per operation
npx -y --package @microsoft/m365agentstoolkit-cli atk add action --api-plugin-type api-spec --openapi-spec-location URL --api-operation "GET /path,POST /path,PATCH /path/{id},DELETE /path/{id}" -i falseRun a single npx -y --package @microsoft/m365agentstoolkit-cli atk add action call per OpenAPI spec, listing all operations as a comma-separated list in --api-operation. Never run separate npx -y --package @microsoft/m365agentstoolkit-cli atk add action calls for different operations from the same spec — this creates multiple plugins instead of one. If npx -y --package @microsoft/m365agentstoolkit-cli atk add action fails, report the error; do NOT fall back to manual creation.
Exception: MCP servers are not supported by
npx -y --package @microsoft/m365agentstoolkit-cli atk add action. Use the MCP Plugin workflow instead.
5. MCP Server Integration
When the user mentions an MCP server URL, follow the MCP Plugin workflow. You MUST discover tools via the MCP protocol handshake (initialize → notifications/initialized → tools/list) — NEVER fabricate tool names/descriptions. For authenticated MCP servers, follow the authentication guide to configure OAuth.
6. Always Update Instructions & Starters After Changes
Adding a capability or plugin without updating instructions is incomplete. After ANY change:
Update instructions to describe the new/changed functionality — every data source should have clear intent coverage (WHEN and WHY to use it) per the Instruction Review quality bar. Built-in capabilities don't need exact names; actions/plugins should be named.
Do NOT list tool names, descriptions, or parameters in instructions — these are already in the plugin metadata (
ai-plugin.json, MCP manifests, capability config). Instructions should contain decision logic only: WHEN to use each tool, chaining rules, and failure handling.Stay within the 8,000-character instruction limit — if close to the limit, cut tool descriptions first
Add at least 1 conversation starter per added capability/plugin
Remove starters that reference removed capabilities
Run the Diagnostic Checklist against the updated instructions to verify quality
7. App Name Requirement
Always update the app name and description to something meaningful. Never leave defaults like "My Agent".
References
Shared
Authentication — OAuth discovery, credentials, oauth/register lifecycle, OAuthPluginVault
Best Practices — Security, performance, testing, compliance
Conversation Design — Authoring instructions and conversation starters from scratch
Instruction Review — Auditing, diagnosing, and improving existing instructions; anti-pattern detection; before/after rewrites
Deployment — ATK CLI workflows, environments, CI/CD
Localization — Multi-language support, tokenized manifests, language files
Workspace Gates — Detailed gate rules, examples, anti-patterns
Scaffolding
Scaffolding Workflow — Step-by-step scaffolding instructions, naming rules, error handling
JSON Development
Editing Workflow — Step-by-step JSON development instructions
Schema — Official JSON schema for agent manifests
API Plugins — OpenAPI integration for JSON agents
MCP Plugin — MCP server integration with RemoteMCPServer, OAuth, response semantics, logo handling
Examples — JSON manifest examples
Files
- ATTRIBUTION.mdAdded by AutoGineer922 B
- LICENSELicence file added by AutoGineer1.1 KiB
- SKILL.md12.6 KiB
- references/api-plugins.md36.2 KiB
- references/authentication.md9.0 KiB
- references/best-practices.md3.5 KiB
- references/conversation-design.md15.6 KiB
- references/deployment.md12.7 KiB
- references/editing-workflow.md15.1 KiB
- references/examples.md11.2 KiB
- references/instruction-review.md45.0 KiB
- references/localization.md18.4 KiB
- references/mcp-plugin.md38.3 KiB
- references/scaffolding-workflow.md8.4 KiB
- references/schema.md3.5 KiB
- references/workspace-gates.md9.2 KiB
references/examples.md
M365 JSON Agent Developer Examples
This document provides workflow examples for common M365 Copilot JSON-based agent development scenarios.
Note: This guide is for JSON-based agents that use
.jsonmanifest files directly.
Example 1: Development and Provisioning
Complete workflow for provisioning a JSON-based agent to a development environment:
# Install dependencies (if any)
npm install
# Provision agent to development environment (no compile step needed for JSON agents)
npx -y --package @microsoft/m365agentstoolkit-cli atk provision --env local --interactive falseResult: Returns a test URL like https://m365.cloud.microsoft/chat/?titleId=T_abc123xyz to test the agent in Microsoft 365 Copilot.
Use case: Testing agent functionality in a live environment during development.
Example 2: Provision and Share Agent
Workflow for provisioning and sharing an agent with your organization:
# Provision agent to target environment
npx -y --package @microsoft/m365agentstoolkit-cli atk provision --env dev --interactive false
# Share agent with tenant users
npx -y --package @microsoft/m365agentstoolkit-cli atk share --scope tenant --env devResult: Agent becomes available to all users in the Microsoft 365 tenant.
Use case: Deploying a shared agent for organizational use after testing and validation.
Example 3: Package Agent for Distribution
Workflow for creating an agent package for distribution:
# Package agent for distribution
npx -y --package @microsoft/m365agentstoolkit-cli atk package --env prodResult: Creates a distributable package file that can be uploaded to the Microsoft 365 admin center or shared externally.
Use case: Creating a final package for production deployment or external distribution.
Example 4: Basic Declarative Agent JSON
A minimal declarative agent manifest file (declarativeAgent.json):
{
"version": "v1.6",
"name": "My Support Agent",
"description": "An agent to help with customer support inquiries",
"instructions": "You are a helpful customer support agent. Help users find information about their issues and guide them to solutions. Be polite and professional at all times."
}Example 5: Agent with Capabilities
A declarative agent with SharePoint and Email capabilities:
{
"version": "v1.6",
"name": "Knowledge Base Agent",
"description": "An agent that searches company knowledge bases and emails",
"instructions": "You help employees find information from our SharePoint knowledge base and relevant emails. Always cite your sources when providing information.",
"capabilities": [
{
"name": "OneDriveAndSharePoint",
"items_by_url": [
{
"url": "https://contoso.sharepoint.com/sites/KnowledgeBase/Documents"
}
]
},
{
"name": "Email"
}
]
}Example 6: Agent with Conversation Starters
A declarative agent with helpful conversation starters:
{
"version": "v1.6",
"name": "HR Assistant",
"description": "An agent that helps employees with HR-related questions",
"instructions": "You are an HR assistant helping employees with common HR questions about policies, benefits, and procedures.",
"conversation_starters": [
{
"title": "Time Off Policy",
"text": "What is our company's time off policy?"
},
{
"title": "Benefits Overview",
"text": "Can you explain our health insurance benefits?"
},
{
"title": "Expense Reports",
"text": "How do I submit an expense report?"
}
]
}Example 7: Agent with API Plugin Action
A declarative agent connected to an external API:
{
"version": "v1.6",
"name": "Repairs Agent",
"description": "An agent that helps manage repair tickets",
"instructions": "You help users create, find, and track repair tickets. Use the repairs API to search for existing tickets and create new ones when requested.",
"actions": [
{
"id": "repairsPlugin",
"file": "plugins/repairs-plugin.json"
}
],
"conversation_starters": [
{
"title": "My Repairs",
"text": "What repairs are assigned to me?"
},
{
"title": "Create Repair",
"text": "I need to create a new repair ticket"
}
]
}Example 8: API Plugin Manifest
A complete API plugin manifest file (plugins/repairs-plugin.json):
{
"schema_version": "v2.4",
"name_for_human": "Repairs API",
"namespace": "repairs",
"description_for_human": "Search and manage repair tickets",
"description_for_model": "Use this plugin to search for repair tickets, get details about specific repairs, and create new repair requests.",
"functions": [
{
"name": "searchRepairs",
"description": "Search for repair tickets by keyword or status"
},
{
"name": "getRepair",
"description": "Get details about a specific repair ticket",
"parameters": {
"type": "object",
"properties": {
"repairId": {
"type": "string",
"description": "The unique ID of the repair ticket"
}
},
"required": ["repairId"]
}
},
{
"name": "createRepair",
"description": "Create a new repair ticket",
"parameters": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the repair"
},
"description": {
"type": "string",
"description": "Detailed description of the issue"
}
},
"required": ["title", "description"]
},
"capabilities": {
"confirmation": {
"type": "AdaptiveCard",
"title": "Create Repair?",
"body": "Create a new repair ticket?"
}
}
}
],
"runtimes": [
{
"type": "OpenApi",
"auth": {
"type": "None"
},
"spec": {
"url": "https://api.contoso.com/openapi.yaml"
}
}
]
}Example 9: Full Agent with All Features
A complete agent combining all features:
{
"version": "v1.6",
"id": "customer-support-agent",
"name": "Customer Support Agent",
"description": "A comprehensive support agent for customer inquiries",
"instructions": "You are a professional customer support agent for Contoso.\n\nResponsibilities:\n1. Search the knowledge base for relevant documentation\n2. Look up repair tickets and their status\n3. Create new repair tickets when requested\n4. Search support emails for context\n\nGuidelines:\n- Always be polite and professional\n- Cite sources when providing information\n- Ask clarifying questions when needed\n- Never share confidential information",
"capabilities": [
{
"name": "OneDriveAndSharePoint",
"items_by_url": [
{
"url": "https://contoso.sharepoint.com/sites/Support/Documents"
}
]
},
{
"name": "Email",
"shared_mailbox": "[email protected]"
},
{
"name": "WebSearch",
"sites": [
{
"url": "https://docs.contoso.com"
}
]
}
],
"actions": [
{
"id": "repairsApi",
"file": "plugins/repairs-plugin.json"
}
],
"conversation_starters": [
{
"title": "Check Repair Status",
"text": "What is the status of my repairs?"
},
{
"title": "Search Knowledge Base",
"text": "How do I troubleshoot connection issues?"
},
{
"title": "Create New Ticket",
"text": "I need to create a new support ticket"
}
],
"disclaimer": {
"text": "This agent provides general support assistance. For urgent issues, please contact our support hotline."
}
}Example 10: Localized Agent
A declarative agent with tokenized strings for multi-language support.
Tokenized declarativeAgent.json
{
"$schema": "https://developer.microsoft.com/json-schemas/copilot/declarative-agent/v1.6/schema.json",
"version": "v1.6",
"name": "[[agent_name]]",
"description": "[[agent_description]]",
"instructions": "$[file]('instructions.txt')",
"conversation_starters": [
{
"title": "[[starter_status_title]]",
"text": "[[starter_status_text]]"
},
{
"title": "[[starter_kb_title]]",
"text": "[[starter_kb_text]]"
}
],
"disclaimer": {
"text": "[[disclaimer_text]]"
}
}manifest.json with localizationInfo
{
"$schema": "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.schema.json",
"manifestVersion": "devPreview",
"localizationInfo": {
"defaultLanguageTag": "en",
"defaultLanguageFile": "en.json",
"additionalLanguages": [
{
"languageTag": "fr",
"file": "fr.json"
}
]
},
"name": {
"short": "Support Agent",
"full": "Customer Support Agent"
},
"description": {
"short": "Get help with support issues",
"full": "An agent that helps resolve customer support issues using internal knowledge bases."
},
"copilotAgents": {
"declarativeAgents": [
{
"id": "declarativeAgent",
"file": "declarativeAgent.json"
}
]
}
}Default language file (en.json)
{
"$schema": "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.Localization.schema.json",
"name.short": "Support Agent",
"name.full": "Customer Support Agent",
"description.short": "Get help with support issues",
"description.full": "An agent that helps resolve customer support issues using internal knowledge bases.",
"localizationKeys": {
"agent_name": "Customer Support Agent",
"agent_description": "An agent that helps resolve customer support issues using internal knowledge bases.",
"starter_status_title": "Check ticket status",
"starter_status_text": "What is the status of my open tickets?",
"starter_kb_title": "Search knowledge base",
"starter_kb_text": "How do I reset my password?",
"disclaimer_text": "This agent provides general support guidance. For urgent issues, contact the helpdesk."
}
}French language file (fr.json)
{
"$schema": "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.Localization.schema.json",
"name.short": "Agent de support",
"name.full": "Agent de support client",
"description.short": "Obtenez de l'aide pour vos problèmes",
"description.full": "Un agent qui aide à résoudre les problèmes de support client à l'aide des bases de connaissances internes.",
"localizationKeys": {
"agent_name": "Agent de support client",
"agent_description": "Un agent qui aide à résoudre les problèmes de support client à l'aide des bases de connaissances internes.",
"starter_status_title": "Vérifier le statut du ticket",
"starter_status_text": "Quel est le statut de mes tickets ouverts ?",
"starter_kb_title": "Rechercher la base de connaissances",
"starter_kb_text": "Comment réinitialiser mon mot de passe ?",
"disclaimer_text": "Cet agent fournit des conseils de support généraux. Pour les problèmes urgents, contactez le service d'assistance."
}
}Reference: localization.md for the full localization workflow
Requirements and compatibility
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: Needs an MCP server, Needs Node.js
Security
What our scanner noticed· Low risk
- Phrasing that asks for actions without confirmation
- Instructions that use the network
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
- Published by
- Microsoft
- Publisher
- Microsoft (Official)
- Source
- microsoft/skills · .github/plugins/microsoft-365-agents-toolkit/skills/declarative-agent-developer · commit 0696600
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
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 declarative-agent-developer.zip