microsoft/hve-core
Publicmirrored fromhttps://github.com/microsoft/hve-coreAvailable
scripts/linting/schemas/agent-frontmatter.schema.json
112lines · 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 per VS Code custom agent specification", |
| 6 | "type": "object", |
| 7 | "required": [ |
| 8 | "description" |
| 9 | ], |
| 10 | "properties": { |
| 11 | "agents": { |
| 12 | "oneOf": [ |
| 13 | { |
| 14 | "type": "array", |
| 15 | "items": { "type": "string" } |
| 16 | }, |
| 17 | { |
| 18 | "type": "string", |
| 19 | "enum": ["*"] |
| 20 | } |
| 21 | ], |
| 22 | "default": "*", |
| 23 | "description": "List of subagent names allowed to be invoked by this agent. Use '*' to allow all subagents." |
| 24 | }, |
| 25 | "description": { |
| 26 | "type": "string", |
| 27 | "minLength": 1, |
| 28 | "description": "A brief description of the custom agent, shown as placeholder text in the chat input field" |
| 29 | }, |
| 30 | "name": { |
| 31 | "type": "string", |
| 32 | "description": "The name of the custom agent. If not specified, the file name is used" |
| 33 | }, |
| 34 | "argument-hint": { |
| 35 | "type": "string", |
| 36 | "description": "Optional hint text shown in the chat input field to guide users on how to interact with the custom agent" |
| 37 | }, |
| 38 | "tools": { |
| 39 | "type": "array", |
| 40 | "items": { |
| 41 | "type": "string" |
| 42 | }, |
| 43 | "description": "A list of tool or tool set names available for this custom agent. Can include built-in tools, tool sets, MCP tools, or tools contributed by extensions" |
| 44 | }, |
| 45 | "model": { |
| 46 | "oneOf": [ |
| 47 | { "type": "string" }, |
| 48 | { |
| 49 | "type": "array", |
| 50 | "items": { "type": "string" } |
| 51 | } |
| 52 | ], |
| 53 | "description": "The AI model(s) to use when running the agent. If not specified, the currently selected model in model picker is used." |
| 54 | }, |
| 55 | "target": { |
| 56 | "type": "string", |
| 57 | "enum": [ |
| 58 | "vscode", |
| 59 | "github-copilot" |
| 60 | ], |
| 61 | "description": "The target environment or context for the custom agent" |
| 62 | }, |
| 63 | "mcp-servers": { |
| 64 | "type": "array", |
| 65 | "items": { |
| 66 | "type": "object" |
| 67 | }, |
| 68 | "description": "Optional list of Model Context Protocol (MCP) server config json to use with custom agents in GitHub Copilot" |
| 69 | }, |
| 70 | "user-invokable": { |
| 71 | "type": "boolean", |
| 72 | "default": true, |
| 73 | "description": "Controls whether the agent appears in the UI for manual invocation." |
| 74 | }, |
| 75 | "disable-model-invocation": { |
| 76 | "type": "boolean", |
| 77 | "default": false, |
| 78 | "description": "When true, prevents this agent from invoking subagents (including other custom agents). It does not affect which model this agent uses or how the model picker works." |
| 79 | }, |
| 80 | "handoffs": { |
| 81 | "type": "array", |
| 82 | "items": { |
| 83 | "type": "object", |
| 84 | "required": ["label", "agent"], |
| 85 | "properties": { |
| 86 | "label": { |
| 87 | "type": "string", |
| 88 | "description": "The display text shown on the handoff button" |
| 89 | }, |
| 90 | "agent": { |
| 91 | "type": "string", |
| 92 | "description": "The target agent identifier to switch to" |
| 93 | }, |
| 94 | "prompt": { |
| 95 | "type": "string", |
| 96 | "description": "The prompt text to send to the target agent" |
| 97 | }, |
| 98 | "model": { |
| 99 | "type": "string", |
| 100 | "description": "Optional model override for the handoff." |
| 101 | }, |
| 102 | "send": { |
| 103 | "type": "boolean", |
| 104 | "description": "Optional boolean flag to auto-submit the prompt (default is false)" |
| 105 | } |
| 106 | } |
| 107 | }, |
| 108 | "description": "Optional list of suggested next actions or prompts to transition between custom agents" |
| 109 | } |
| 110 | }, |
| 111 | "additionalProperties": false |
| 112 | } |
| 113 | |