Hopp til innhold

MCP API-referanse

Fullstendig referanse for alle 11 kundevendte Maguyva MCP-verktøy. Hvert verktøy inkluderer parametere, bruksveiledning og anbefalinger for når det egner seg best.

API-oversikt#

Maguyva MCP API eksponerer for øyeblikket 11 kundevendte verktøy fordelt på 4 hovedkategorier:

  • Kjernesøkeverktøy - Avanserte søkefunksjoner på tvers av kodebasen din
  • Strukturelle og grafverktøy - AST-spørringer, symboloppslag og avhengighetsanalyse
  • Kodeanalyseverktøy - Dyp kodeanalyse og kartlegging av sammenhenger
  • System- og hjelpeverktøy - Repokontekst, deterministisk beregning og veiledning

Alle verktøy bruker et konsistent format for repo-identifikator: "owner/repo:branch". Branch settes til main som standard hvis den ikke er spesifisert.

Utelat repository når MCP-klienten oppgir en standard for den aktuelle forespørselen, eller når nøkkelen har tilgang til nøyaktig ett repo; ellers oppgir du den eksplisitt. Bruk repository_context(action="info", repository="owner/repo") for å se hvordan et repo løses.

Format for repo-parameter#

Alle MCP-verktøy bruker dette formatet for repo-identifikator:

  • Med gren: "owner/repo:branch" - f.eks. "owner/repository:develop"
  • Standard gren: "owner/repo" - bruker hovedgren når ingen gren er spesifisert "owner/repository"
  • Standard for forespørsel eller eneste repo: Utelat repoet når MCP-klienten oppgir en standard for den aktuelle forespørselen, eller når nøkkelen har tilgang til nøyaktig ett repo; ellers oppgir du det eksplisitt

Eksempler på ledetekster:

Spør om en spesifikk repo:    "Søk owner/my-repo etter autentiseringsmellomvare"
Liste tilgjengelige reposer:  "Hvilke arkiver kan denne Maguyva-nøkkelen få tilgang til?"
Overstyr for ett søk:         "Søk i owner/other-repo:develop etter autentiseringsmønstre"

Språkfiltrering#

Alle søkeverktøy støtter filtrering av resultater etter programmeringsspråk:

  • language_filter="python" - Filtrer til kun Python-filer
  • language_filter="typescript" - Filtrer til kun TypeScript-filer
  • Skiller mellom store/små bokstaver: Bruk språknavn med små bokstaver
  • Standard: Tom streng (ingen filtrering) - returnerer resultater fra alle språk
  • Støttet dekning: Språkfiltre fungerer på tvers av alle 279+ støttede språk og tekstbaserte teknologier. Se kompatibilitet for den fullstendige listen.
"Finn autentiseringsmiddleware kun i Python-filer"
"Søk etter databasetilkoblinger i TypeScript"

API-referanse generert fra kildekode 22. juli 2026.

Grunnleggende søkeverktøy#

Start her for alle kodebasespørsmål. Gi den et naturlig språksøk (f.eks. "hvordan fungerer godkjenning", "hvor håndteres fakturering"), og den rutes automatisk på tvers av semantikk, symbol, strukturell, og avhengighetssøk av den indekserte repoen. Foretrekk dette fremfor Explore-agenten og Grep/Glob for utforskning og planlegging - den søker i hele den indekserte repoen samtidig i stedet for å skanne filer.

Parametere:

queryPåkrevd
Type
str
Beskrivelse
Søkespørring
repositoryValgfri
Type
str
Beskrivelse
Repo som owner/repo[:branch]. Valgfritt — utelat for å bruke klientens standard for den aktuelle forespørselen (når den er oppgitt) eller det eneste tilgjengelige repoet; oppgi eksplisitt bare for å velge et annet indeksert repo. Svaret viser hvilket repo som ble brukt.
modeValgfri
Type
Literal[auto, hybrid, semantic, text, structural, ast, graph]
Standard
auto
Beskrivelse
Søkemodus
limitValgfri
Type
int
Standard
10
Beskrivelse
Maks antall resultater i dette rangerte top-K-vinduet
language_filterValgfri
Type
str
Beskrivelse
Språkfilter
path_filterValgfri
Type
str
Beskrivelse
Filtrer etter filbaneprefiks
boost_by_importanceValgfri
Type
bool
Standard
Beskrivelse
Opt-in: ranger på nytt etter sentralitet med symbolspesifikke grafmetrikker (is_articulation_point, bridge_count, k_core, centrality osv.). Av som standard for agentsikker rangering (globale hubber kan drukne implementasjonstreff); aktiver for arkitekturomvisninger. Gjelder for alle 4 modaliteter når hvert resultat har symbolkobling.
branchValgfri
Type
str
Beskrivelse
Grenoverstyring
qualityValgfri
Type
Literal[quick, balanced, thorough]
Standard
balanced
Beskrivelse
Forhåndsinnstilt søkekvalitet
include_contentValgfri
Type
bool
Standard
true
Beskrivelse
Inkluder innhold i resultatene
explain_routingValgfri
Type
bool
Standard
Beskrivelse
Inkluder forklaring av rutebeslutning
importance_weightValgfri
Type
float
Standard
0.3
Beskrivelse
Vekt for viktighetsøkning (0=ingen, 1=full)
orphansValgfri
Type
bool
Standard
Beskrivelse
Inkluder foreldreløse symboler (ingen innkommende referanser)
include_community_contextValgfri
Type
bool
Standard
Beskrivelse
Inkluder relaterte symboler fra samme kodefellesskap
community_depthValgfri
Type
int
Standard
1
Beskrivelse
Dybde utvidelse av fellesskapskontekst
graph_viewValgfri
Type
Literal[dependency, type, data_flow, control_flow]
Standard
dependency
Beskrivelse
Grafvisning for beregninger
seed_symbol_idsValgfri
Type
list[str]
Beskrivelse
Tier-1 oppgavefrø: symbol-IDer sentrale for gjeldende oppgave. Når innstilt, omrangerer sammensmeltede treff etter Approach A dybdeforfallsnærhet (nøyaktig seed-match + grafkanthopp). Additiv — utelat for global rangering.
seed_file_pathsValgfri
Type
list[str]
Beskrivelse
Tier-1 oppgavefrø: indekserte filbaner agenten har åpnet eller nettopp redigert. Når angitt, omrangerer sammenslåtte treff etter banenærhet med 1/(1+d) dybdeforfall (samme fil → samme dir → pakker i nærheten). Additiv — utelat for global rangering.

Best egnet for:

  • Indeksomfattende eller cold-start-utforskning når det er uklart hvilket verktøy som er riktig
  • Multimodal sammenslått rangering på tvers av semantisk, tekst, strukturell og graf

Ikke anbefalt for:

  • Et kjent symbolnavn — bruk find_symbol direkte
  • En kjent sti på disk — bruk lokal Read/Grep først

Finn kode etter betydning, ikke eksakt tekst. Bruk dette for konseptuelle søk som "retry-logikk" eller "onboardingflyt for brukere" når du ikke kjenner nøkkelordet eller symbolnavnet. Returnerer de mest relevante kodebitene rangert etter viktighet. Foretrekk dette fremfor Grep når søket er konseptuelt.

Parametere:

queryPåkrevd
Type
str
Beskrivelse
Søkeord (konseptuelt, meningsbasert)
repositoryValgfri
Type
str
Beskrivelse
Repo som owner/repo[:branch]. Valgfritt — utelat for å bruke klientens standard for den aktuelle forespørselen (når den er oppgitt) eller det eneste tilgjengelige repoet; oppgi eksplisitt bare for å velge et annet indeksert repo. Svaret viser hvilket repo som ble brukt.
limitValgfri
Type
int
Standard
5
Beskrivelse
Maks antall resultater i dette rangerte top-K-vinduet
similarity_thresholdValgfri
Type
float
Standard
0.6
Beskrivelse
Minimum likhetspoeng
language_filterValgfri
Type
str
Beskrivelse
Språkfilter (python, typescript, etc.)
path_filterValgfri
Type
str
Beskrivelse
Filtrer etter filbaneprefiks
boost_by_importanceValgfri
Type
bool
Standard
Beskrivelse
Opt-in: ranger på nytt etter PageRank-sentralitet (av som standard for agentsikker rangering; aktiver for arkitekturomvisninger)
branchValgfri
Type
str
Beskrivelse
Grenoverstyring (standard: fra repository-parameteren eller main)
include_contentValgfri
Type
bool
Standard
true
Beskrivelse
Ta med delinnhold i resultatene
graph_viewValgfri
Type
Literal[dependency, type, data_flow, control_flow]
Standard
dependency
Beskrivelse
Grafvisning for metrikker

Best egnet for:

  • Konseptuelle søk ("hvordan fungerer auth?", "cachestrategi")
  • Likhetssøk på tvers av pakker

Ikke anbefalt for:

  • Et kjent symbolnavn — bruk find_symbol i stedet
  • Eksakte strenger eller feilmeldinger — bruk text_pattern_search

Søk i indeksert innhold. Modusene exact og regex bruker grep på hele fil-/blobkorpuset; fuzzy content-modus søker i det avgrensede korpuset med semantiske kodebiter. Omfangene file og symbol støtter bare fuzzy-modus. Bruk lokal Grep for en avgrenset katalog som allerede er på disken.

Parametere:

queryPåkrevd
Type
str
Beskrivelse
Tekstmønster å søke etter
repositoryValgfri
Type
str
Beskrivelse
Repo som owner/repo[:branch]. Valgfritt — utelat for å bruke klientens standard for den aktuelle forespørselen (når den er oppgitt) eller det eneste tilgjengelige repoet; oppgi eksplisitt bare for å velge et annet indeksert repo. Svaret viser hvilket repo som ble brukt.
modeValgfri
Type
Literal[fuzzy, exact, regex]
Standard
exact
Beskrivelse
Søkemodus
search_scopeValgfri
Type
Literal[content, symbols, files]
Standard
content
Beskrivelse
Hva du skal søke etter
limitValgfri
Type
int
Standard
5
Beskrivelse
Maks antall resultater returnert på denne siden
offsetValgfri
Type
int
Beskrivelse
Utdatert kompatibilitets-offset. Foretrekk cursor fra pagination.next_cursor.
cursorValgfri
Type
str
Beskrivelse
Ugjennomsiktig cursor fra pagination.next_cursor. Send den uendret, og hold query og filtre uendret.
language_filterValgfri
Type
str
Beskrivelse
Språkfilter
path_filterValgfri
Type
str
Beskrivelse
Filtrer etter filbaneprefiks
case_sensitiveValgfri
Type
bool
Standard
Beskrivelse
Skiller mellom store og små bokstaver
branchValgfri
Type
str
Beskrivelse
Grenoverstyring
fuzzy_algorithmValgfri
Type
Literal[hybrid, trigram, levenshtein]
Standard
hybrid
Beskrivelse
Fuzzy matching algoritme
thresholdValgfri
Type
float
Standard
0.05
Beskrivelse
Minimum likhetsterskel for fuzzy
semantic_fallbackValgfri
Type
bool
Standard
Beskrivelse
Gå tilbake til semantisk søk ​​hvis ingen resultater

Best egnet for:

  • Eksakte strenger, feilmeldinger og regex
  • Trigram fuzzy-matching for tekst med nestenmatch

Ikke anbefalt for:

  • En kjent sti på disk — foretrekk lokal Grep
  • Konseptuelle søk — bruk semantic_search

Strukturelle og grafbaserte verktøy#

Foretrekk preset=functions|classes|methods|imports|variables (eller fritt pattern=). Finner kode etter AST-form (ikke tekst). Filtre på mellomnivå: name_pattern, node_type, decorator, parent_child. Path-/ltree-/call-filtre er avanserte — sett advanced=true når du bruker dem bevisst; flate advanced-nøkler godtas fortsatt for bakoverkompatibilitet. Oppgi minst én strukturell selektor.

Parametere:

repositoryValgfri
Type
str
Beskrivelse
Repo som owner/repo[:branch]. Valgfritt — utelat for å bruke klientens standard for den aktuelle forespørselen (når den er oppgitt) eller det eneste tilgjengelige repoet; oppgi eksplisitt bare for å velge et annet indeksert repo. Svaret viser hvilket repo som ble brukt.
presetValgfri
Type
Literal[functions, classes, methods, imports, variables]
Beskrivelse
Foretrukket strukturell selektor. Utvides til språkuavhengige AST-nodetyper — functions (funksjons-/pil-/metodedefinisjoner på tvers av språk); classes (class-/struct-/impl-definisjoner); methods (metodedefinisjoner, samt function_definition for språk uten metodenode); imports (import-/use-/include-setninger); variables (variable-/let-/const-/static-deklarasjoner). Foretrekk fremfor fritt pattern/node_type for browse-lignende spørringer.
patternValgfri
Type
str
Beskrivelse
Free-form-mønster når presets er for grove (oppdages automatisk: 'def foo(' → node_type + name_pattern). Foretrekk preset= for browse-spørringer.
name_patternValgfri
Type
str
Beskrivelse
Symbolnavnmønster (skall-wildcard, avgrenset POSIX-regex eller fuzzy tekst; maks 256 tegn)
node_typeValgfri
Type
str
Beskrivelse
AST-nodetype (function_definition, class_definition osv.) — foretrekk preset= for vanlige former
decoratorValgfri
Type
str
Beskrivelse
Filter for dekoratørnavn
base_classValgfri
Type
str
Beskrivelse
Basisklassefilter
language_filterValgfri
Type
str
Beskrivelse
Språkfilter (python, typescript, etc.)
limitValgfri
Type
int
Standard
20
Beskrivelse
Maks antall resultater returnert på denne siden
offsetValgfri
Type
int
Beskrivelse
Utdatert kompatibilitets-offset. Foretrekk cursor fra pagination.next_cursor.
cursorValgfri
Type
str
Beskrivelse
Ugjennomsiktig cursor fra pagination.next_cursor. Send den uendret, og hold query og filtre uendret.
path_filterValgfri
Type
str
Beskrivelse
Filtrer etter filbaneprefiks
branchValgfri
Type
str
Beskrivelse
Grenoverstyring
query_typeValgfri
Type
Literal[node_type, name_pattern, parent_child]
Beskrivelse
Eksplisitt spørringstype
parent_typeValgfri
Type
str
Beskrivelse
Overordnet AST nodetypefilter
relationshipValgfri
Type
Literal[parent, ancestor]
Standard
parent
Beskrivelse
For parent_child-spørringer: bare direkte overordnet, eller en hvilken som helst stamfar (bruk stamfar for klassemetoder nestet under en klassekropp/blokk)
has_modifierValgfri
Type
str
Beskrivelse
Filtrer etter modifikator (eksport, asynkron, statisk, etc.)
advancedValgfri
Type
bool
Standard
Beskrivelse
Angi true når du med vilje bruker avanserte bane-, ltree- eller anropsfiltre (ltree_ancestor, ltree_descendant, min_depth, max_depth, field_role, definition_name, callee_text, callee_name). Som standard holder false agentgrensesnittet fokusert på forhåndsinnstillinger. Avanserte nøkler i flatt format fungerer fortsatt for bakoverkompatibilitet, med en metadataadvarsel.
callee_textValgfri
Type
str
Beskrivelse
Avansert — foretrekk preset=functions|classes|methods|imports|variables. Filter for callee-tekst i et kalluttrykk. Sett advanced=true når du bevisst bruker path-/ltree-/call-filtre.
callee_nameValgfri
Type
str
Beskrivelse
Avansert — foretrekk preset=functions|classes|methods|imports|variables. Filter for callee-navn i et kalluttrykk. Sett advanced=true når du bevisst bruker path-/ltree-/call-filtre.
field_roleValgfri
Type
str
Beskrivelse
Avansert — foretrekk preset=functions|classes|methods|imports|variables. Filter for AST-feltrolle. Sett advanced=true når du bevisst bruker path-/ltree-/call-filtre.
ltree_ancestorValgfri
Type
str
Beskrivelse
Avansert — foretrekk preset=functions|classes|methods|imports|variables. Filter for AST-ltree-forfedresti. Sett advanced=true når du bevisst bruker path-/ltree-/call-filtre.
ltree_descendantValgfri
Type
str
Beskrivelse
Avansert — foretrekk preset=functions|classes|methods|imports|variables. Filter for AST-ltree-etterkommersti. Sett advanced=true når du bevisst bruker path-/ltree-/call-filtre.
definition_nameValgfri
Type
str
Beskrivelse
Avansert — foretrekk preset=functions|classes|methods|imports|variables. Filter for definisjonsnavn. Sett advanced=true når du bevisst bruker path-/ltree-/call-filtre.
min_depthValgfri
Type
int
Beskrivelse
Avansert — foretrekk preset=functions|classes|methods|imports|variables. Minste AST-dybde. Sett advanced=true når du bevisst bruker path-/ltree-/call-filtre.
max_depthValgfri
Type
int
Beskrivelse
Avansert — foretrekk preset=functions|classes|methods|imports|variables. Største AST-dybde. Sett advanced=true når du bevisst bruker path-/ltree-/call-filtre.

Best egnet for:

  • Struktur på AST-nivå: classes, decorators, function-/method-presets
  • Finne kode etter form i stedet for tekst

Ikke anbefalt for:

  • Fritekst eller konseptuelle søk — bruk semantic_search eller intelligent_search

Primær påvirkningsradius-/grafoverflate. Svarer på "hva kaller dette?" / "hva bruker dette?" via den virkelige kall-/importgrafen. For påvirkning før endring: analysis_type="dependents" eller analysis_type="impact" (innkommende, shallow som standard for impact), include_metrics=false som standard (kan aktiveres for centrality + refactor_risk). PR-/diff-påvirkning (P1-8): send changed_paths og/eller patch (unified diff) — løser symboler per sti og returnerer en kompakt, grunt innkommende dependents-nyttelast uten å kreve et symbolnavn. Etter en endring, sett verify_after_edit=true med targets og/eller changed_paths for en kompakt multi-root-nyspørring av berørte symboler. Støtter også dependencies, centrality og orphans. analyze_dependencies er et tynt alias for impact-stien — foretrekk dette verktøyet for nye agenter.

Parametere:

repositoryValgfri
Type
str
Beskrivelse
Repo som owner/repo[:branch]. Valgfritt — utelat for å bruke klientens standard for den aktuelle forespørselen (når den er oppgitt) eller det eneste tilgjengelige repoet; oppgi eksplisitt bare for å velge et annet indeksert repo. Svaret viser hvilket repo som ble brukt.
queryValgfri
Type
str
Beskrivelse
Symbolnavn eller søkeord
targetValgfri
Type
str
Beskrivelse
Symbolnavn (alias for spørring)
changed_pathsValgfri
Type
list[str]
Beskrivelse
Repo-relative baner for PR/diff-påvirkning (standard) eller, med verify_after_edit=true, bekreftelsesrøtter etter redigering. PR/diff: løser symboler per bane og går grunne innkommende avhengige; kan kombineres med patch=. Bekreft: løser opp til 5 symboler per bane som bekreftelsesrøtter (avkortet nederst i verifiseringsmodus). Krever ikke query/target for PR/diff-påvirkning.
patchValgfri
Type
str
Beskrivelse
PR/diff innvirkning: enhetlig diff / git patch-tekst. Baner analyseres fra diff --git / --- / +++ overskrifter; samme kompakte støtbane som changed_paths.
analysis_typeValgfri
Type
Literal[centrality, dependencies, dependents, impact, orphans]
Standard
dependencies
Beskrivelse
Analysemodus. impact = påvirkningsradius (innkommende dependents; shallow dybde når depth er utelatt). dependents svarer også på impact. Når changed_paths eller patch er satt, tvinges analysen til PR-/diff-impact. centrality/orphans krever ikke et target.
depthValgfri
Type
Literal[shallow, balanced, deep]
Standard
balanced
Beskrivelse
Traverseringsdybde. For analysis_type=impact og PR-/diff-impact er standardverdien i praksis shallow med mindre du setter depth eksplisitt.
limitValgfri
Type
int
Standard
20
Beskrivelse
Maks antall resultater returnert på denne siden
offsetValgfri
Type
int
Beskrivelse
Utdatert kompatibilitets-offset. Foretrekk cursor fra pagination.next_cursor.
cursorValgfri
Type
str
Beskrivelse
Ugjennomsiktig cursor fra pagination.next_cursor. Send den uendret, og hold query og filtre uendret.
path_filterValgfri
Type
str
Beskrivelse
Begrenser oppløsningen av målsymbolet til et filbaneprefiks; returnerte grafrelasjoner kan strekke seg utenfor den stien
language_filterValgfri
Type
str
Beskrivelse
Filtrerer måloppløsning og browse-resultater etter språk
directionValgfri
Type
Literal[outgoing, incoming, both]
Beskrivelse
Traverseringsretning (overstyrer analysis_type-slutning)
relationship_typesValgfri
Type
list[str]
Beskrivelse
Filtrerer kanttyper (CALL, IMPORT, INHERITS_FROM osv.). En ikke-tom liste overstyrer graph_view-standardverdiene.
exclude_test_pathsValgfri
Type
bool
Standard
true
Beskrivelse
Standard true: ekskluderer test-, fixture-, vendor- og eksempelstier fra traverserings- og sentralitetsresultater. Sett false for å inkludere dem. Orphan-analysen bruker alltid sine egne strengere støyekskluderinger.
exclude_generated_pathsValgfri
Type
bool
Standard
Beskrivelse
Ekskluder genererte deklarasjoner pluss build, dekning, cache, kildekart og minifiserte artefaktbaner fra kryssingsresultater
include_module_symbolsValgfri
Type
bool
Standard
Beskrivelse
Som standard ekskluderer false grafkanter når from_name eller to_name er det syntetiske __module__-symbolet (støy på modulnivå). Sett true til å inkludere kanter på modulnivå i resultater for avhengighets- og avhengighetsforhold.
branchValgfri
Type
str
Beskrivelse
Grenoverstyring
per_hop_limitValgfri
Type
int
Beskrivelse
Maks antall relasjoner per hop (1-300)
include_metricsValgfri
Type
bool
Standard
Beskrivelse
Valgfrie grafmetrikker på resultatrader (komprimert med refactor_risk). Metrikker hentes også internt når min_centrality>0, men returneres bare når dette er true.
metrics_detailValgfri
Type
Literal[summary, full]
Standard
summary
Beskrivelse
Når include_metrics=true: summary (standard) returnerer beslutningssignaler + refactor_risk; full returnerer det større kuraterte metriske settet
include_edge_metadataValgfri
Type
bool
Standard
Beskrivelse
Inkluder rå kantmetadata og vekter (stor). Kompakte nyttelaster forlater dette.
symbol_typesValgfri
Type
list[str]
Beskrivelse
Filtrerer returnerte symboler etter type (function, class, method osv.)
exact_matchValgfri
Type
bool
Standard
Beskrivelse
Krev nøyaktig samsvar med symbolnavn
find_similar_patternsValgfri
Type
bool
Standard
Beskrivelse
Finn lignende bruksmønstre
min_centralityValgfri
Type
float
Standard
0
Beskrivelse
Minste PageRank-score. Metrikker hentes internt for filtrering; graph_metrics returneres bare når include_metrics=true.
graph_viewValgfri
Type
Literal[dependency, type, data_flow, control_flow]
Standard
dependency
Beskrivelse
Grafvisning brukt for traverseringsrelasjoners standardverdier, metrikker og sentralitetsrangering; orphan-analyse beregnes på tvers av alle visninger
verify_after_editValgfri
Type
bool
Standard
Beskrivelse
P2-7 bekreftelsesmodus etter redigering: Spør den indekserte effektgrafen på nytt for nylig redigerte symboler i en kompakt multi-root-respons. Krever targets og/eller changed_paths (eller target/query). Standarder til grunne innkommende pårørende; resultatene gjenspeiler den indekserte grafen (kan forsinke direkte redigeringer). Når det er sant, går det foran PR/diff-påvirkning på samme changed_paths.
targetsValgfri
Type
list[str]
Beskrivelse
Når verify_after_edit=true: symbolnavn som skal verifiseres på nytt (oppringere/avhengige). Slått sammen med target/query hvis begge følger med.

Best egnet for:

  • Blast-radius-/konsekvensanalyse før du redigerer et delt symbol
  • PR-/diff-påvirkning via changed_paths eller patch
  • Verifisering etter redigering via verify_after_edit

Ikke anbefalt for:

  • Enkle tekst- eller symboloppslag — bruk text_pattern_search eller find_symbol

Kodeanalyseverktøy#

find_symbolStabil

Hopp til der en funksjon, klasse eller variabel er definert og brukt. Bruk når du kjenner navnet (f.eks. "getCurrentUser") - raskere og mer presis enn Grep, og den spenner over hele den indekserte repoen. Returnerer eventuelt referanser og viktighetsberegninger.

Parametere:

symbol_nameValgfri
Type
str
Beskrivelse
Symbolnavn å søke etter (valgfritt — utelat for å bla etter metrikker)
repositoryValgfri
Type
str
Beskrivelse
Repo som owner/repo[:branch]. Valgfritt — utelat for å bruke klientens standard for den aktuelle forespørselen (når den er oppgitt) eller det eneste tilgjengelige repoet; oppgi eksplisitt bare for å velge et annet indeksert repo. Svaret viser hvilket repo som ble brukt.
scopeValgfri
Type
Literal[definitions, references, both]
Standard
both
Beskrivelse
Søkeomfang
limitValgfri
Type
int
Standard
15
Beskrivelse
Maks antall resultater returnert på denne siden
offsetValgfri
Type
int
Beskrivelse
Utdatert kompatibilitets-offset. Foretrekk cursor fra pagination.next_cursor.
cursorValgfri
Type
str
Beskrivelse
Ugjennomsiktig cursor fra pagination.next_cursor. Send den uendret, og hold query og filtre uendret.
find_similarValgfri
Type
bool
Standard
Beskrivelse
Ta med lignende symbolnavn
include_metricsValgfri
Type
bool
Standard
Beskrivelse
Ta med sentralitetsmetrikker
metrics_detailValgfri
Type
Literal[summary, full]
Standard
summary
Beskrivelse
Når include_metrics=true: summary (standard) returnerer beslutningssignaler + refactor_risk; full returnerer det større kuraterte metriske settet
path_filterValgfri
Type
str
Beskrivelse
Filtrer etter filbaneprefiks
branchValgfri
Type
str
Beskrivelse
Grenoverstyring
symbol_typeValgfri
Type
Literal[function, class, variable, method, constant, module, interface, type]
Beskrivelse
Filtrer etter symboltype
high_impactValgfri
Type
bool
Standard
Beskrivelse
Bla gjennom arkitektonisk viktige symboler (utelat symbol_name). Standardmodus er popularity (øverste PageRank-desil minus utility-megahuber). Sett high_impact_mode=risk for artikulasjons-/bro-skjæringspunkter.
high_impact_modeValgfri
Type
Literal[popularity, risk]
Standard
popularity
Beskrivelse
Når high_impact=true: popularitet = topp PageRank decil minus mega-hubs/moduler; risiko = artikulasjonspoeng rangert etter SMV bridge_count deretter k_core (strukturell refaktorrisiko, ikke nav-popularitet)
in_cycleValgfri
Type
bool
Standard
Beskrivelse
Filtrer til symboler i avhengighetssykluser
exclude_test_pathsValgfri
Type
bool
Standard
true
Beskrivelse
Når du surfer etter grafberegninger, ekskluder tester, fixtures, tredjepartskode og eksempler før rangering. Oppslag etter et navngitt symbol er uendret.

Best egnet for:

  • Feste et kjent symbols definisjon, referanser og grafberegninger
  • Bla gjennom etter centrality, high_impact eller in_cycle når symbol_name er utelatt

Ikke anbefalt for:

  • Konseptuelle søk eller søk i ukjent område — bruk intelligent_search eller semantic_search

analyze_dependenciesStabil

Alias for påvirkningsradius via dependency_search (dependents/incoming). Foretrekk dependency_search med analysis_type="dependents" eller "impact" for nye agenter. Beholder den gamle multi-hop impact-responsformen (graph, connection_summary, valgfrie metrikker med refactor_risk). Bruk graph_view til å avgrense relasjonsfamilien: dependency (standard), type, data_flow, control_flow.

Parametere:

repositoryValgfri
Type
str
Beskrivelse
Repo som owner/repo[:branch]. Valgfritt — utelat for å bruke klientens standard for den aktuelle forespørselen (når den er oppgitt) eller det eneste tilgjengelige repoet; oppgi eksplisitt bare for å velge et annet indeksert repo. Svaret viser hvilket repo som ble brukt.
targetPåkrevd
Type
str
Beskrivelse
Symbolnavn som skal analyseres
depthValgfri
Type
Literal[shallow, balanced, deep]
Standard
balanced
Beskrivelse
Analysedybde
limitValgfri
Type
int
Standard
10
Beskrivelse
Maks antall resultater returnert på denne siden
offsetValgfri
Type
int
Beskrivelse
Utdatert kompatibilitets-offset. Foretrekk cursor fra pagination.next_cursor.
cursorValgfri
Type
str
Beskrivelse
Ugjennomsiktig cursor fra pagination.next_cursor. Send den uendret, og hold query og filtre uendret.
directionValgfri
Type
Literal[incoming, outgoing, both]
Standard
incoming
Beskrivelse
Traverseringsretning
relationship_typesValgfri
Type
list[str]
Beskrivelse
Filterkanttyper (CALL, IMPORT, INHERITS_FROM, etc.). Overstyrer alltid den graph_view-avledede standarden nedenfor når den leveres.
graph_viewValgfri
Type
Literal[dependency, type, data_flow, control_flow]
Standard
dependency
Beskrivelse
Grafvisning: bestemmer både standard krysskanttyper og hvilken visnings beregninger som brukes når include_metrics=true. dependency=[CALL,IMPORT,EXPORTS,REFERENCE,INSTANTIATES] (standard), type=[INHERITS_FROM,IMPLEMENTS,OVERRIDE,DECORATES,OF_TYPE], data_flow=[READS,WRITES,ASSIGNS_TO], control_flow=[CONTROL_FLOW,THROWS,CATCHES]. Bare brukt som relationship_types-standard når relationship_types ikke er eksplisitt oppgitt. Matcher dependency_searchs eksisterende graph_view-parameternavn for konsistens på tvers av verktøy.
path_filterValgfri
Type
str
Beskrivelse
Begrenser oppløsningen av målsymbolet til et filbaneprefiks; returnerte grafrelasjoner kan strekke seg utenfor den stien
language_filterValgfri
Type
str
Beskrivelse
Språkfilter
branchValgfri
Type
str
Beskrivelse
Grenoverstyring
per_hop_limitValgfri
Type
int
Beskrivelse
Maks antall relasjoner per hop (1-300)
include_metricsValgfri
Type
bool
Standard
Beskrivelse
Inkluder grafberegninger i resultatene, hver beriket med en avledet refactor_risk-blokk ({risk: "low"|"medium"|"high", is_articulation_point, bridge_count, k_core, graph_view, reasons}). risiko er "low" når det ikke er et artikulasjonspunkt (i den valgte visningen), "medium" når et artikulasjonspunkt som bygger bro over få kanter, "high" når man bygger bro over mange (heuristisk terskel, ikke empirisk validert). Utelatt per symbol når det ikke finnes noen metrikkrad for det symbolet/visningen.
metrics_detailValgfri
Type
Literal[summary, full]
Standard
summary
Beskrivelse
Når include_metrics=true: summary (standard) returnerer beslutningssignaler + refactor_risk; full returnerer det større kuraterte metriske settet
include_edge_metadataValgfri
Type
bool
Standard
Beskrivelse
Inkluder rå kantmetadata og vekter. Deaktivert som standard fordi uttrekksmetadata kan være store; berikelsesdekning rapporteres når den er aktivert.
exclude_test_pathsValgfri
Type
bool
Standard
true
Beskrivelse
Standard true: ekskluder test-, fixtur-, leverandør- og eksempelbaner fra returnerte grafkanter. Sett false til å inkludere dem.
include_module_symbolsValgfri
Type
bool
Standard
Beskrivelse
Som standard ekskluderer false grafkanter når from_name eller to_name er det syntetiske __module__-symbolet. Sett true til å inkludere kanter på modulnivå.

Best egnet for:

  • Eldre kallere som allerede er koblet til responsformen (graph, connection_summary)

Ikke anbefalt for:

  • Nye agent-looper — foretrekk dependency_search, som deler samme traverseringskjerne

get_task_contextStabil

Begynner du å jobbe i et ukjent område? Beskriv oppgaven (f.eks. "legg til SSO-støtte", "fiks faktureringswebhooken") og få tilbake en avgrenset pakke med relevante filer, kode, symboler og avhengigheter i ett kall. Seed-filer bidrar med direkte indeksert innhold selv når de ikke definerer noen symboler. For flere resultater, fortsett med det spesialiserte søkeverktøyet for det laget.

Parametere:

task_descriptionPåkrevd
Type
str
Beskrivelse
Beskrivelse av oppgaven du trenger kontekst til
repositoryValgfri
Type
str
Beskrivelse
Repo som owner/repo[:branch]. Valgfritt — utelat for å bruke klientens standard for den aktuelle forespørselen (når den er oppgitt) eller det eneste tilgjengelige repoet; oppgi eksplisitt bare for å velge et annet indeksert repo. Svaret viser hvilket repo som ble brukt.
limitValgfri
Type
int
Standard
15
Beskrivelse
Maksimalt antall resultater per lag
scopeValgfri
Type
Literal[semantic, symbols, dependencies, all]
Standard
all
Beskrivelse
Hvilke kontekstlag som skal inkluderes
language_filterValgfri
Type
str
Beskrivelse
Språkfilter
path_filterValgfri
Type
str
Beskrivelse
Filtrer etter filbaneprefiks
branchValgfri
Type
str
Beskrivelse
Grenoverstyring
include_related_contextValgfri
Type
bool
Standard
Beskrivelse
Inkluder relatert kontekst fra tilstøtende symboler
seed_symbol_idsValgfri
Type
list[str]
Beskrivelse
Eksplisitte Tier-1-seeds: symbol-ID-er agenten allerede vet er sentrale for oppgaven (f.eks. symboler i filer den har åpne). Rangeres foran nøkkelordavledede seeds i lagene dependencies/related_context. Dette er additivt — utelat for å beholde dagens oppførsel med bare nøkkelord.
seed_file_pathsValgfri
Type
list[str]
Beskrivelse
Tier-1 eksplisitte seeds: indekserte filbaner agenten har åpne eller nettopp har redigert. Returnerer avgrensede direkte filbevis og løser opptil 5 symboler per fil for grafkontekst, inkludert symbolfri dokumentasjon og konfigurasjon. Additivt — utelat for et rent nøkkelordbasert oppførsel.

Best egnet for:

  • Oppgavebevisst kontekst som blander seed-filer med semantiske, symbol- og avhengighetslag

Ikke anbefalt for:

  • Enkeltverktøy-oppslag der et mer spesifikt verktøy allerede svarer på spørsmålet

get_fileStabil

Leser en fil fra det indekserte repoet etter sti. Foretrekk det lokale Read-verktøyet for filer på disk — bruk dette for oppslag i andre repoer eller eksternt når filen ikke finnes i arbeidstreet ditt. Støtter et valgfritt linjeområde; fortsett en token-avkuttet respons fra metadata.next_line_start.

Parametere:

file_pathPåkrevd
Type
str
Beskrivelse
Filbane i forhold til depotroten
repositoryValgfri
Type
str
Beskrivelse
Repo som owner/repo[:branch]. Valgfritt — utelat for å bruke klientens standard for den aktuelle forespørselen (når den er oppgitt) eller det eneste tilgjengelige repoet; oppgi eksplisitt bare for å velge et annet indeksert repo. Svaret viser hvilket repo som ble brukt.
line_startValgfri
Type
int
Beskrivelse
Startlinje (1-indeksert)
line_endValgfri
Type
int
Beskrivelse
Sluttlinje (1-indeksert, inklusive; må være ved eller etter line_start)
branchValgfri
Type
str
Beskrivelse
Grenoverstyring
max_tokensValgfri
Type
int
Standard
5000
Beskrivelse
Maksimalt antall tokens å returnere
include_metadataValgfri
Type
bool
Standard
true
Beskrivelse
Inkluder filmetadata som svar

Best egnet for:

  • Eksterne eller indekserte filøyeblikksbilder (linjeområder, tokengrenser)

Ikke anbefalt for:

  • En sti som allerede er på lokal disk — bruk det lokale Read-verktøyet

System- og hjelpeverktøy#

repository_contextStabil

Lister repoene du kan søke i, eller henter identitetsinformasjon om ett (namespace/branch, indexed_commit_sha / indeksens ferskhet). Kall action:"list" én gang for å finne den nøyaktige repo-slugen søkeverktøyene godtar. (Hvis nøkkelen din bare har ett repo, bruker søkeverktøyene det som standard — da kan du hoppe over dette.) Namespace-brede fil-/blob-/kant-tellinger er valgfrie via include_statistics=true.

Parametere:

actionPåkrevd
Type
Literal[list, info]
Beskrivelse
Handling: "list" for å vise tilgjengelige repoer eller "info" for å hente repoinformasjon
repositoryValgfri
Type
str
Beskrivelse
Repository i formatet owner/repo eller owner/repo:branch (påkrevd for info)
branchValgfri
Type
str
Beskrivelse
Grenoverstyring
patternValgfri
Type
str
Beskrivelse
Filtrer depotlisten etter mønster
include_statisticsValgfri
Type
bool
Standard
Beskrivelse
Opt-in: inkluderer namespace-brede tellinger av indeksert data (fil/blob/kant). Standard false — repoets identitet krever ikke dette tregere aggregatet.
limitValgfri
Type
int
Standard
20
Beskrivelse
Maks antall resultater returnert på denne siden
offsetValgfri
Type
int
Beskrivelse
Utdatert kompatibilitetsforskyvning. Foretrekk cursor fra pagination.next_cursor.
cursorValgfri
Type
str
Beskrivelse
Ugjennomsiktig cursor fra pagination.next_cursor. Send den uendret og behold spørringen og filtrene uendret.

Best egnet for:

  • Liste opp tilgjengelige repoer
  • Fastslå repo-identitet, branch og HEAD-kontra-indeks-ferskhet

Ikke anbefalt for:

  • Namespace-brede statistikker som standard — send include_statistics=true eksplisitt, siden det kan være tregere enn oppløsning

ask_maguyvaStabil

Hjelp og tilbakemelding for Maguyva. Primært: få verktøyveiledning, eller send inn en feilrapport / funksjonsforespørsel som lagres for Maguyvas vedlikeholdere. Ta aldri med hemmeligheter eller sensitive personopplysninger i tilbakemeldinger. operasjonen evaluate finnes bare for bakoverkompatibilitet — foretrekk lokal beregning eller vertsverktøy for matte-/hash-/strengarbeid.

Parametere:

operationPåkrevd
Type
Literal[guidance, report_bug, request_feature, evaluate]
Beskrivelse
Primært: guidance, report_bug, request_feature. Bare legacy/kompatibilitet: evaluate (deterministisk uttrykksmotor; ikke del av den primære agent-arbeidsflyten).
queryValgfri
Type
str
Beskrivelse
Veiledningstema (f.eks. tool_selection, semantic_search). Bare for legacy evaluate: uttrykksstreng.
descriptionValgfri
Type
str
Beskrivelse
Kreves for report_bug og request_feature. Free-form-tilbakemelding for Maguyva-vedlikeholdere. Ta aldri med hemmeligheter eller sensitive personopplysninger.
related_toolValgfri
Type
Literal[ask_maguyva, get_file, repository_context, find_symbol, structural_search, dependency_search, analyze_dependencies, semantic_search, text_pattern_search, intelligent_search, get_task_context]
Beskrivelse
Valgfritt Maguyva-verktøy som er nærmest knyttet til tilbakemeldingen

Best egnet for:

  • Verktøyveiledning (operation="guidance")
  • Varige feilrapporter og funksjonsforespørsler for vedlikeholderne av Maguyva

Ikke anbefalt for:

  • Matte-/hash-/strengberegning — operasjonen evaluate finnes bare for bakoverkompatibilitet; foretrekk lokal vertsberegning

Beste praksis#

  1. Bruk eksplisitte overstyringer bevisst: Utelat repoet når MCP-klienten oppgir en standard for den aktuelle forespørselen, eller når nøkkelen har tilgang til nøyaktig ett repo; ellers oppgir du det eksplisitt.
  2. Velg riktig søkemodus: Bruk intelligent_search med mode="auto" i de fleste tilfeller. Angi en modus når du vet nøyaktig hva du trenger.
  3. Utnytt språkfiltre: Bruk language_filter for å begrense resultater og forbedre ytelsen.
  4. GraphRAG-forsterkning: GraphRAG-viktighetsforsterkning er avslått som standard for semantisk søk (boost_by_importance=false) for å holde rangeringen agent-sikker. Send boost_by_importance=true for å aktivere sentralitetsbevisst omrangering for arkitekturgjennomganger.
  5. Repo-matching er ufølsom for store/små bokstaver, ikke uskarp: repository_context matcher reponavn uavhengig av store/små bokstaver — det retter ikke skrivefeil. Sjekk metadata.resolution_reason på info-handlingen ("exact" mot "corrected") for å se hvordan et navn ble løst.
  6. Kombiner verktøy: Bruk flere API-metoder sammen for omfattende analyse.
  7. Håndter store resultater: Bruk limit og verktøyspesifikke pagineringskontroller (for eksempel line_start/line_end i get_file).
  8. Bruk ask_maguyva for verktøyveiledning: ask_maguyvas evaluate-operasjon (hash, base64, JSON, matte) er kun legacy / for bakoverkompatibilitet. Kall i stedet ask_maguyva med operation="guidance" og query="tool_selection" for local-tool-wins-matrisen og en full verktøy-for-verktøy-jukselapp.
  9. Verifiser konsekvenser før og etter redigering: Før du redigerer et delt symbol, kall dependency_search med analysis_type="impact" (eller send changed_paths for PR-/diff-konsekvens) for å se konsekvensradiusen. Etter redigering, sett verify_after_edit=true med targets og/eller changed_paths for en kompakt gjenkontroll av de samme symbolene.

Ytelsesegenskaper#

OperasjonYtelsesnotater
Semantisk søkUnder ett sekund, men inkluderer hver gang et live embedding-API-kall (caches ikke) — regn med ekstra ventetid i tillegg til vektorspørringen
TekstsøkUnder ett sekund for eksakt/regex; uskarpt fritekstsøk paginerer klientsiden, så dype offset koster mer — avgrens med path_filter/language_filter
Strukturelt søkAST-indeksert — kostnaden skalerer med resultatvolumet, ikke med repostørrelsen
AvhengighetssøkKostnaden skalerer med dybden — foretrekk depth="shallow" med mindre du trenger kontekst med flere hopp; per_hop_limit begrenser spredningen
FilhentingNesten øyeblikkelig for én enkelt fil — del opp store filer med line_start/line_end eller max_tokens i stedet for ett stort uttrekk
RepokontekstNavneromsoppløsning caches bare per forespørsel, ikke på tvers av kall — hvert verktøykall løses opp på nytt
ask_maguyva (guidance / evaluate)Nesten øyeblikkelig — kjører in-Worker uten databasekall

Feilhåndtering#

Alle API-metoder returnerer en strukturert konvolutt:

  • status: Streng — "success" eller "error". Signaler om svekket treff eller ferskhet finnes i nøstede felt som metadata.resolution_reason på repository_context eller metadata.index_freshness.status.
  • tool: Navnet på verktøyet som genererte svaret
  • data: Resultatinnhold ved suksess (strukturen varierer per verktøy)
  • error: Strukturert feilobjekt når status er "error" — inkluderer type, message, suggestions og recovery_actions
  • metadata: Tilleggsinformasjon om operasjonen (ruting, caching, parameterjusteringer)
  • pagination: Til stede på listesvar — inkluderer has_more og next_cursor

Sjekk alltid feltet status før du behandler resultatene — det er alltid enten "success" eller "error". For signaler om svekket treff eller ferskhet, les i stedet det nøstede feltet: metadata.resolution_reason på repository_context, eller metadata.index_freshness.status (known/partial/unknown/unavailable).

Kom i gang#

  1. Konfigurer MCP-klienten: Pek MCP-klienten mot endepunktet til Maguyva-serveren
  2. Bekreft tilgang til repoer: Bruk repository_context med "list" eller "info" for å undersøke repoene API-nøkkelen har tilgang til
  3. Begynn å søke: Begynn med intelligent_search og utforsk spesialiserte verktøy etter behov
  4. Kombiner verktøy: Bruk flere verktøy sammen for en omfattende kodeanalyse

For detaljerte integrasjonsinstruksjoner, se installasjonsguide.