Repository navigation
Query vs q #221
Description
Describe the bug
A clear and concise description of what the bug is.
In the search functions below, there is still mention of q instead of query the docs say query and using q throws a api error
search_codesearch_issues
Affected version
Please run docker run -i --rm ghcr.io/github/github-mcp-server ./github-mcp-server --version and paste the output below
server version v0.1.1 (7ab5d96) 2025-04-07T16:05:06Z
Steps to reproduce the behavior
- Type this '...'
- View the output '....'
- See error
Expected vs actual behavior
A clear and concise description of what you expected to happen and what actually happened.
Logs
Paste any available logs. Redact if needed.
Activity
williammartin commentedon Apr 11, 2025
Hey @eavanvalkenburg,
So just to be clear, the issue is that the README should be updated to mention
qinstead ofquery?I'm a bit confused by this, since the implementations use
q, and that looks to be correctly passed through to the GitHub API. Did you mean that usingquerythrows an API error?eavanvalkenburg commentedon Apr 11, 2025
I'm not sure anymore, all I do know is that either the documentation is wrong or the code is wrong... might be that I was getting an error because my PAT did not have access to do search...
SamMorrowDrums commentedon Apr 13, 2025
I also think q is also a poor name, as making the LLM more certain of what the field means is more useful than copying the API - so I think we should ensure this is correct, but also converge on the best solution for the LLM and not the API.
SamMorrowDrums commentedon Apr 13, 2025
I have also encountered an agent having this confusion, so it's definitely not imagined!
williammartin commentedon Apr 23, 2025
I'm closing this based on #327 but I have a separate issue around generating this all automatically #223
Merge pull request github#221 from docker/add-astro-docs-server
feat: improve search_code for LLM agent consumption