Skip to content

Query vs q #221

Closed
Closed
@eavanvalkenburg

Description

@eavanvalkenburg

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.

Activity

williammartin

williammartin commented on Apr 11, 2025

@williammartin
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

eavanvalkenburg commented on Apr 11, 2025

@eavanvalkenburg
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

SamMorrowDrums commented on Apr 13, 2025

@SamMorrowDrums
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

SamMorrowDrums commented on Apr 13, 2025

@SamMorrowDrums
Collaborator

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

williammartin

williammartin commented on Apr 23, 2025

@williammartin
Collaborator

I'm closing this based on #327 but I have a separate issue around generating this all automatically #223

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @williammartin@SamMorrowDrums@eavanvalkenburg

        Issue actions

          Query vs q · Issue #221 · github/github-mcp-server