microsoft/hve-core
Publicmirrored from https://github.com/microsoft/hve-coreAvailable
scripts/linting/schemas/agent-frontmatter.schema.json
79lines · modecode
| 1 | { |
| 2 | "$schema": "https://json-schema.org/draft/2020-12/schema", |
| 3 | "$id": "https://github.com/microsoft/hve-core/schemas/agent-frontmatter.schema.json", |
| 4 | "title": "Agent File Frontmatter Schema", |
| 5 | "description": "Frontmatter schema for .agent.md files in VS Code custom agents", |
| 6 | "type": "object", |
| 7 | "required": ["description"], |
| 8 | "properties": { |
| 9 | "description": { |
| 10 | "type": "string", |
| 11 | "minLength": 1, |
| 12 | "description": "A brief description of the custom agent, shown as placeholder text in the chat input field" |
| 13 | }, |
| 14 | "name": { |
| 15 | "type": "string", |
| 16 | "description": "The name of the custom agent. If not specified, the file name is used" |
| 17 | }, |
| 18 | "maturity": { |
| 19 | "type": "string", |
| 20 | "enum": ["stable", "preview", "experimental", "deprecated"], |
| 21 | "default": "stable", |
| 22 | "description": "Maturity level affecting visibility in stable vs pre-release builds. Stable appears in all builds; preview/experimental only in pre-release." |
| 23 | }, |
| 24 | "argument-hint": { |
| 25 | "type": "string", |
| 26 | "description": "Optional hint text shown in the chat input field to guide users on how to interact with the custom agent" |
| 27 | }, |
| 28 | "tools": { |
| 29 | "type": "array", |
| 30 | "items": { |
| 31 | "type": "string" |
| 32 | }, |
| 33 | "description": "A list of tool or tool set names that are available for this custom agent. Can include built-in tools, tool sets, MCP tools, or tools contributed by extensions" |
| 34 | }, |
| 35 | "model": { |
| 36 | "type": "string", |
| 37 | "description": "The AI model to use when running the prompt. If not specified, the currently selected model in model picker is used" |
| 38 | }, |
| 39 | "target": { |
| 40 | "type": "string", |
| 41 | "enum": ["vscode", "github-copilot"], |
| 42 | "description": "The target environment or context for the custom agent" |
| 43 | }, |
| 44 | "mcp-servers": { |
| 45 | "type": "array", |
| 46 | "items": { |
| 47 | "type": "object" |
| 48 | }, |
| 49 | "description": "Optional list of Model Context Protocol (MCP) server config json to use with custom agents in GitHub Copilot" |
| 50 | }, |
| 51 | "handoffs": { |
| 52 | "type": "array", |
| 53 | "items": { |
| 54 | "type": "object", |
| 55 | "required": ["label", "agent", "prompt"], |
| 56 | "properties": { |
| 57 | "label": { |
| 58 | "type": "string", |
| 59 | "description": "The display text shown on the handoff button" |
| 60 | }, |
| 61 | "agent": { |
| 62 | "type": "string", |
| 63 | "description": "The target agent identifier to switch to" |
| 64 | }, |
| 65 | "prompt": { |
| 66 | "type": "string", |
| 67 | "description": "The prompt text to send to the target agent" |
| 68 | }, |
| 69 | "send": { |
| 70 | "type": "boolean", |
| 71 | "description": "Optional boolean flag to auto-submit the prompt (default is false)" |
| 72 | } |
| 73 | } |
| 74 | }, |
| 75 | "description": "Optional list of suggested next actions or prompts to transition between custom agents. Handoff buttons appear as interactive suggestions after a chat response completes" |
| 76 | } |
| 77 | }, |
| 78 | "additionalProperties": false |
| 79 | } |
| 80 | |