Skip to main content
Glama

FoxAPIs data sources

GitHub search

github_search
Read-onlyIdempotent

Search GitHub for repositories, users or code by keyword; returns the total and the top matches. Costs 1 credit a call; an answer with no data is not charged. Needs your FoxAPIs key (free to start).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "query": "<query>"
    },
    "name": "github_search"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryYesFor example: "web scraping api"
search_typeNoFor example: "repositories"repositories

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare read-only, open-world, idempotent and non-destructive, so the safety profile is covered. The description goes beyond them with a concrete cost model (1 credit per call, no charge for empty answers) and an authentication requirement (FoxAPIs key), both of which materially affect whether an agent should call it. It stops short of stating result caps or rate limits.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single dense sentence with the purpose front-loaded, followed by return shape, cost, and auth — each clause carries distinct information. No filler beyond a minor promotional phrase ('free to start').

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter read tool with no output schema, the definition covers purpose, return shape, cost, and auth, which is most of what an agent needs. Missing are result-count limits and the full allowed set of search_type values, which would help it plan calls.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline would be 3, but the description adds real meaning: it enumerates the entity types covered ('repositories, users or code'), effectively documenting the valid search_type values, whereas the schema only shows a single example value. It does not add syntax guidance for the query string beyond 'by keyword'.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Search GitHub') plus the entity coverage (repositories, users, code) and what is returned. It implicitly separates the tool from narrower siblings like github_repo and github_user by being a keyword search, but never names those alternatives.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied by 'by keyword' and the repositories default, so an agent can infer this is the exploratory/general search path. However, there is no explicit guidance on when to prefer it over the entity-specific siblings such as github_repo or github_user.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources