关于自定义代理
自定义代理是 Copilot 代理的专用版本,您可以根据独特的工作流程、编码约定和使用场景进行定制。它们就像量身定制的团队成员,遵循您的标准,使用合适的工具,并实现团队特定的实践。您只需一次性定义这些代理,而无需反复提供相同的指令和上下文。
您可以使用名为代理配置文件的 Markdown 文件来定义自定义代理。这些文件指定提示、工具和 MCP 服务器,从而直接在 Copilot 中编码您的约定、框架和期望结果。
代理配置文件定义了自定义代理的行为。当您将代理分配给任务或议题时,将实例化该自定义代理。
代理配置文件格式
代理配置文件是带有 YAML 前置块的 Markdown 文件。在最简形式下,它们包括
- Name (optional):自定义代理的显示名称。如果省略,则使用代理文件名作为其标识符和默认显示名称。
- Description:说明代理的用途和功能。
- Prompt:定义代理行为和专长的自定义指令。
- Tools (optional):代理可访问的特定工具。默认情况下,代理可以访问所有可用工具,包括内置工具和 MCP 服务器工具。
代理配置文件还可以使用 mcp-servers 属性包含 MCP 服务器配置。
示例代理配置文件
此示例是一个包含名称、描述和提示配置的基础代理配置文件。
---
name: readme-creator
description: Agent specializing in creating and improving README files
---
You are a documentation specialist focused on README files. Your scope is limited to README files or other related documentation files only - do not modify or analyze code files.
Focus on the following instructions:
- Create and update README.md files with clear project descriptions
- Structure README sections logically: overview, installation, usage, contributing
- Write scannable content with proper headings and formatting
- Add appropriate badges, links, and navigation elements
- Use relative links (e.g., `docs/CONTRIBUTING.md`) instead of absolute URLs for files within the repository
- Make links descriptive and add alt text to images
可以配置自定义代理的地点
您可以在不同层级定义代理配置文件
- Repository level:在仓库中创建
.github/agents/CUSTOM-AGENT-NAME.md,用于项目专属的代理。 - Organization or enterprise level:在
.github-private仓库中创建/agents/CUSTOM-AGENT-NAME.md,以实现更广泛的可用性。
欲了解更多信息,请参阅 在组织中准备使用自定义代理 与 在企业中准备使用自定义代理。
可以使用自定义代理的地点
注意
自定义代理目前在 JetBrains IDE、Eclipse 和 Xcode 中公开预览,且可能会更改。
创建自定义代理后,它们将在以下环境中可用:
- Copilot cloud agent on GitHub.com:代理选项卡与面板、议题分配以及拉取请求
- Copilot cloud agent in IDEs:Visual Studio Code、JetBrains IDE、Eclipse 与 Xcode
- GitHub Copilot CLI
您可以直接在 Visual Studio Code、JetBrains IDE、Eclipse 和 Xcode 中使用代理配置文件。某些属性在不同环境间可能表现不同或被忽略。
欲了解在 Visual Studio Code 中使用自定义代理的更多信息,请参阅 VS Code 中的自定义代理。
后续步骤
要创建您自己的自定义代理,请参阅