Expand description
The github_search tool — live GitHub code/issue search.
Where KnowledgeSearchTool searches the
indexed snapshot a GithubConnector ingested, github_search hits the
live GitHub search API so the agent can find code or issues that landed
after the last ingest — fresh lookups beyond the indexed corpus.
§Shape
Arguments: { "query": string, "kind"?: "code" | "issues" }. The tool runs
the query through a pluggable GithubSearchBackend (default:
OctocrabGithubSearch, the real GitHub API) and renders the top results
(title, URL, snippet).
§Scope + auth
The tool is constructed with a GithubAuth and a default owner/repo
scope; the scope is folded into the search query (repo:owner/name) so the
agent’s lookups stay within the team’s repos by default.
§Test split (G9)
The live network is behind the OctocrabGithubSearch backend, exercised
only by an #[ignore] + env-gated (SMOOTH_AGENT_E2E=1) test. The tool’s
arg-parsing and result-formatting are unit-tested offline against a stub
backend, exactly like the web_search tool.
Structs§
- Github
Search Result - A single GitHub search hit.
- Github
Search Tool - A
Toolthat runs a live GitHub search through aGithubSearchBackend, scoped to a defaultowner/repo. - Octocrab
Github Search - The real backend: live GitHub search via
octocrab.
Enums§
- Github
Auth - How the
github_searchtool authenticates to the GitHub API. - Github
Search Kind - Which GitHub search index to query.
Traits§
- Github
Search Backend - A pluggable GitHub-search backend.