Custom-agent reference documents reasoningEffort, but the working frontmatter key is reasoning-effort
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 88/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- github
- Domain
- cli, documentation
Research direction
Open the linked Custom Agents Reference and search for reasoningEffort, including its description and precedence examples. Update the reference to document reasoning-effort as the working frontmatter key, while retaining both spellings only if the camelCase form is actually supported; done means the documented syntax matches the reported working behavior.
Written by the indexing model from the issue text.
Description
Describe the bug
The Copilot CLI custom-agent reference documents reasoningEffort as a frontmatter field. In Copilot CLI 1.0.88, that spelling did not apply the configured effort when I selected the agent with /agent. Changing only the field name to reasoning-effort made it work.
This matches the syntax reported in a comment on #2904. The reference currently leads users to configure a field that does not work in this case.
Affected version
GitHub Copilot CLI 1.0.88; macOS arm64.
Steps to reproduce the behavior
- Define a custom agent with
reasoningEffort: "low"in its YAML frontmatter. - Select it with
/agentand observe that the configured effort does not take effect. - Change only that key to
reasoning-effort: "low", reload the agent, and select it again. - Observe that the configured effort now takes effect.
Expected behavior
Update the custom-agent frontmatter reference to document reasoning-effort as the working key, including its description and precedence examples. If reasoningEffort is also intended to be supported, document both spellings and fix the camelCase spelling separately; it should not be presented as working while it is not.
Additional context
The issue is the documented frontmatter spelling, not a request to add per-agent reasoning effort: that capability was addressed in #2904.
- Dominant language
- Shell
- Stars
- 11.3k
- Forks
- 2k
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/copilot-cli
-
area:sessions
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
github/copilot-cli#5147 ·
-
area:input-keyboard
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
github/copilot-cli#5113 ·
-
area:sessions
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
github/copilot-cli#4996 ·
-
triage
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
github/copilot-cli#4932 ·
-
triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
github/copilot-cli#4909 ·
All issues in github/copilot-cli
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Netcracker/qubership-test-pipelines#307 ·
Maintainers usually reply within 2 days
-
Webcam overlay freezes during voxtype dictation while screen recording (pause_media pauses the overlay mpv)Possibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
TYPO3BestPractices/tea#2409 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
msys2/MSYS2-packages#6825 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
fw876/helloworld#2067 ·
Maintainers usually reply within 1 day