This article is designed to help you build an entirely new GitHub Copilot ํ์ฅ. To instead learn how to quickly build and test a demo Copilot ํ์ฅ created by GitHub, see Quickstart for GitHub Copilot Extensions using agents.
๊ธฐ์ ์ธํธ์ ์์ด์ ํธ๋ Copilot ํ์ฅ์ฑ ํ๋ซํผ์ ํตํด Copilot์ ๊ธฐ๋ฅ๊ณผ ์ปจํ ์คํธ๋ฅผ ํ์ฅํ๋ ๋ ๊ฐ์ง ๋ฐฉ๋ฒ์ ๋๋ค. ์ธ๋ถ ์๋น์ค์ API๋ฅผ Copilot ์ฑํ ์ ํตํฉํ ์ ์์ง๋ง ๊ฐ๊ฐ ๋ค๋ฅธ ์ฌ์ฉ ์ฌ๋ก๋ฅผ ์ ๊ณตํ๊ณ ๋ค์ํ ์์ค์ ์ ์ด์ ๋ณต์ก์ฑ์ ์ ๊ณตํฉ๋๋ค.
- ๊ธฐ์ ์ธํธ๋ Copilot๊ฐ ์ต์ํ์ ์ค์ ์ผ๋ก ํน์ ์์ (์: ๋ฐ์ดํฐ ๊ฒ์์ด๋ ๊ฐ๋จํ ์์ )์ ์ํํด์ผ ํ๋ ๊ฐ๋ฐ์๋ฅผ ์ํด ๊ฐ๋ณ๊ณ ๊ฐ์ํ๋์์ต๋๋ค. ๋ผ์ฐํ , ํ๋กฌํํธ ์์ฑ, ํจ์ ํ๊ฐ, ์๋ต ์์ฑ์ ์๋์ผ๋ก ์ฒ๋ฆฌํ๋ฏ๋ก ๋น ๋ฅด๊ณ ๊ฐ๋จํ ํตํฉ์ ์ ํฉํฉ๋๋ค. For more information about skillsets, see About skillsets for Copilot Extensions.
- ์์ด์ ํธ๋ ์์ฒญ์ด ์ฒ๋ฆฌ๋๊ณ ์๋ต์ด ์์ฑ๋๋ ๋ฐฉ์์ ์์ ํ ์ ์ดํด์ผ ํ๋ ๋ณต์กํ ํตํฉ์ ์ํ ๊ฒ์ ๋๋ค. ์ฌ์ฉ์ ์ง์ ๋ ผ๋ฆฌ๋ฅผ ๊ตฌํํ๊ณ , ๋ค๋ฅธ LLM ๋ฐ/๋๋ Copilot API์ ํตํฉํ๊ณ , ๋ํ ์ปจํ ์คํธ๋ฅผ ๊ด๋ฆฌํ๊ณ , ์ฌ์ฉ์ ์ํธ ์์ฉ์ ๋ชจ๋ ์ธก๋ฉด์ ์ฒ๋ฆฌํ ์ ์์ต๋๋ค. ์์ด์ ํธ๋ ๋ ๋ง์ ์์ง๋์ด๋ง๊ณผ ์ ์ง ๊ด๋ฆฌ๊ฐ ํ์ํ์ง๋ง, ์ ๊ตํ ์ํฌํ๋ก๋ฅผ ์ํ ์ต๋ ์ ์ฐ์ฑ์ ์ ๊ณตํฉ๋๋ค. ์์ด์ ํธ์ ๋ํ ์์ธํ ๋ด์ฉ์ About agents for Copilot Extensions์(๋ฅผ) ์ฐธ์กฐํ์ธ์.
1. Learn about Copilot ์์ด์ ํธ
Copilot ์์ด์ ํธ contain the custom code for your Copilot ํ์ฅ, and integrate with a GitHub App to form the Copilot ํ์ฅ itself. For more information, see About agents for Copilot Extensions.
To successfully build a Copilot ์์ด์ ํธ, you need to understand how the agent communicates with:
- The Copilot platform using server-sent events. See Configuring your Copilot agent to communicate with the Copilot platform.
- The GitHub API. See Configuring your Copilot agent to communicate with GitHub.
2. Review example Copilot ์์ด์ ํธ and the Copilot ํ์ฅ SDK
To see the previous concepts in practice and learn about agent implementations, review the following example agents and software development kit (SDK), all of which are available in the copilot-extensions
organization:
- Blackbeard (best starting point): A simple agent that responds to requests like a pirate using Copilot's large language model (LLM) API and special system prompts.
- GitHub Models: A more complex agent that lets you ask about and interact with various LLMs listed on the GitHub Marketplace through Copilot ์ฑํ . The GitHub Models agent makes use of function calling.
- Function Calling: An example agent written in Go that demonstrates function calling and confirmation dialogs.
- RAG Extension: An example agent written in Go that demonstrates a simple implementation of retrieval augmented generation.
- Preview SDK: An SDK that streamlines the development of Copilot ํ์ฅ by handling request verification, payload parsing, and response formatting automatically. This SDK allows extension builders to focus more on creating core functionality and less on boilerplate code.
3. Build a Copilot ์์ด์ ํธ
Using the reference material from the previous steps, plan and build your Copilot ์์ด์ ํธ. You can choose to implement any of the following options:
- To avoid building and managing your own LLM deployment, your agent can call the Copilot LLM deployment. See Using Copilot's LLM for your agent.
- To quickly interpret user input and choose from a variety of predefined functions to execute, you can implement function calling in your agent. To learn more, see How to use function calling with Azure OpenAI Service in the Azure OpenAI documentation and Function calling in the OpenAI documentation.
4. Deploy your Copilot ์์ด์ ํธ
To make your Copilot ์์ด์ ํธ accessible to the Copilot platform and GitHub, you need to deploy it to a server that is reachable by HTTP request. See Configuring your server to host your Copilot extension.
5. Create a GitHub App and integrate it with your Copilot ์์ด์ ํธ
To create a Copilot ํ์ฅ, you need to create and configure a GitHub App, then integrate it with your Copilot ์์ด์ ํธ. See Creating a GitHub App for your Copilot Extension and Configuring your GitHub App for your Copilot extension.
6. Choose the availability of your Copilot ํ์ฅ
Choose one of two visibility levels for your Copilot ํ์ฅ:
- Public: Any user or organization account with the installation page link for the extension can install it.
- Private: Only the user or organization account that created the extension can install it.
If you make your Copilot ํ์ฅ public, you can then choose to list it on the GitHub Marketplace.
To learn how to change the visibility of your Copilot ํ์ฅ and list it on the GitHub Marketplace, see Managing the availability of your Copilot Extension.
Next steps
To learn how to use your Copilot ํ์ฅ, see Using extensions to integrate external tools with Copilot Chat.
1. Learn about Github Copilot ๊ธฐ์ ์ธํธ
Github Copilot ๊ธฐ์ ์ธํธ contain the custom code for your Copilot ํ์ฅ, and integrate with a GitHub App to form the Copilot ํ์ฅ itself.
Unlike Copilot ์์ด์ ํธ, Copilot ๊ธฐ์ ์ธํธ handle the logic behind prompt crafting, function evaluation, and response generation, making them an ideal choice for developers seeking quick and effective integrations with minimal effort. For more information, see About skillsets for Copilot Extensions.
2. Build a Copilot ๊ธฐ์ ์ธํธ
To explore an example of a skillset implementation, see the skillset-example repository in the copilot-extensions
organization.
To build a skillset, see Building Copilot skillsets.
3. Deploy your Copilot ๊ธฐ์ ์ธํธ
To make your Copilot ๊ธฐ์ ์ธํธ accessible to the Copilot platform and GitHub, you need to deploy it to a server that is reachable by HTTP request. See Configuring your server to host your Copilot extension.
4. Create a GitHub App and integrate it with your Copilot ๊ธฐ์ ์ธํธ
To create a Copilot ํ์ฅ, you need to create and configure a GitHub App, then integrate it with your Copilot ๊ธฐ์ ์ธํธ. See Creating a GitHub App for your Copilot Extension and Configuring your GitHub App for your Copilot extension.
5. Choose the availability of your Copilot ๊ธฐ์ ์ธํธ
Choose one of two visibility levels for your Copilot ํ์ฅ:
- Public: Any user or organization account with the installation page link for the extension can install it.
- Private: Only the user or organization account that created the extension can install it.
If you make your Copilot ํ์ฅ public, you can then choose to list it on the GitHub Marketplace.
To learn how to change the visibility of your Copilot ํ์ฅ and list it on the GitHub Marketplace, see Managing the availability of your Copilot Extension.
Next steps
To learn how to use your Copilot ํ์ฅ, see Using extensions to integrate external tools with Copilot Chat.