Skip to content

Query vs q #221

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

Open
eavanvalkenburg opened this issue Apr 11, 2025 · 4 comments
Open

Query vs q #221

eavanvalkenburg opened this issue Apr 11, 2025 · 4 comments
Labels
bug Something isn't working enhancement New feature or request

Comments

@eavanvalkenburg
Copy link

eavanvalkenburg commented Apr 11, 2025

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_code
  • search_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

  1. Type this '...'
  2. View the output '....'
  3. 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.

@eavanvalkenburg eavanvalkenburg added the bug Something isn't working label Apr 11, 2025
@williammartin
Copy link
Collaborator

Hey @eavanvalkenburg,

So just to be clear, the issue is that the README should be updated to mention q instead of query?

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

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 using query throws an API error?

@eavanvalkenburg
Copy link
Author

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
Copy link
Collaborator

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
Copy link
Collaborator

I have also encountered an agent having this confusion, so it's definitely not imagined!

@SamMorrowDrums SamMorrowDrums added the enhancement New feature or request label Apr 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants