Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to create GitHub Copilot chat variables using tools #8026

Open
swvanbuuren opened this issue Feb 11, 2025 · 0 comments
Open

Document how to create GitHub Copilot chat variables using tools #8026

swvanbuuren opened this issue Feb 11, 2025 · 0 comments
Assignees
Labels
doc-enhancement suggested addition or improvement

Comments

@swvanbuuren
Copy link

The chat extension guide doesn't cover chat variables (anymore): In the past it was mentioned that chat variables were in a proposed state, but recently this was removed altogether.

I found out the hard way how to get working chat variables, by browsing VS Code's sources: when adding a tool in package.json, one needs to add the following key/values (in addition to the documented ones):

  • "canBeReferencedInPrompt": true
  • "userDescription": "Description of chat variable" (optional, shown in menu afaik)
  • "icon": "$(note)" (optional, shown next to description in menu)

Only if the first key/value is added, the chat variable is usable in the chat (highlighted in blue, tab-completion works) and becomes available as tool. I suspect there are also other key/values that are also worth mentioning in relation to chat variables.

Please add guidance to the chat extension guide and tools guide on how to create new chat variables for GitHub Copilot chat.

@ntrogh ntrogh added the doc-enhancement suggested addition or improvement label Feb 12, 2025
@ntrogh ntrogh self-assigned this Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-enhancement suggested addition or improvement
Projects
None yet
Development

No branches or pull requests

2 participants