Spring til indhold

MCP API-reference

Komplet reference for alle 11 kundevendte Maguyva MCP-værktøjer. Hvert værktøj indeholder parametre, brugsvejledning og anbefalinger til, hvad det er bedst til.

API-overblik#

Maguyva MCP API'et eksponerer i øjeblikket 11 kundevendte værktøjer fordelt på 4 hovedkategorier:

  • Kernesøgeværktøjer - Avancerede søgemuligheder på tværs af din kodebase
  • Strukturelle værktøjer & grafværktøjer - AST-forespørgsler, symbolopslag og afhængighedsanalyse
  • Kodeanalyseværktøjer - Dyb kodeanalyse og relationskortlægning
  • System- og hjælpeværktøjer - Repository-kontekst, deterministisk beregning og vejledning

Alle værktøjer bruger et konsistent repository-identifikatorformat: "owner/repo:branch". Branch er som standard main, hvis ikke angivet.

Udelad repository, når MCP-klienten angiver en standard for den aktuelle forespørgsel, eller når nøglen har adgang til præcis ét repo; angiv den ellers eksplicit. Brug repository_context(action="info", repository="owner/repo") til at se, hvordan et repo matches.

Format for repository-parameter#

Alle MCP-værktøjer bruger dette repository-identifikatorformat:

  • Med branch: "owner/repo:branch" - f.eks., "owner/repository:develop"
  • Standardbranch: "owner/repo" - bruger main-branchen, når ingen branch er angivet "owner/repository"
  • Standard for forespørgsel eller eneste repo: Udelad repoet, når MCP-klienten angiver en standard for den aktuelle forespørgsel, eller når nøglen har adgang til præcis ét repo; angiv det ellers eksplicit

Eksempler på prompts:

Spørg om et bestemt repo:        "Søg owner/my-repo efter authentication middleware"
Vis tilgængelige repoer:         "Hvilke repoer har denne Maguyva-nøgle adgang til?"
Tilsidesæt for én forespørgsel:  "Søg owner/other-repo:develop efter godkendelsesmønstre"

Sprogfiltrering#

Alle søgeværktøjer understøtter filtrering af resultater efter programmeringssprog:

  • language_filter="python" - Filtrer til kun Python-filer
  • language_filter="typescript" - Filtrer til kun TypeScript-filer
  • Versalfølsom: Brug små bogstaver til sprognavne
  • Standard: Tom streng (ingen filtrering) - returnerer resultater fra alle sprog
  • Understøttet dækning: Sprogfiltre fungerer på tværs af den fulde 279+ understøttede sprog og tekstbaserede teknologier. Se kompatibilitet for den fulde liste.
"Find authentication middleware kun i Python-filer"
"Søg efter databaseforbindelser i TypeScript"

API-reference genereret fra kilden den 22. juli 2026.

Kernesøgeværktøjer#

Start her med alle spørgsmål om kodebasen. Giv en forespørgsel på naturligt sprog (f.eks. "hvordan fungerer godkendelse", "hvor håndteres fakturering"), så dirigeres den automatisk mellem semantisk søgning, symbolsøgning, strukturel søgning og afhængighedssøgning i det indekserede repo. Foretræk dette frem for Explore-agenten og Grep/Glob til udforskning og planlægning — hele det indekserede repo søges igennem på én gang i stedet for at scanne filer.

Parametre:

queryPåkrævet
Type
str
Beskrivelse
Søgeforespørgsel
repositoryValgfri
Type
str
Beskrivelse
Repo som owner/repo[:branch]. Valgfrit — udelad for at bruge klientens standard for den aktuelle forespørgsel (hvis den er angivet) eller det eneste tilgængelige repo; angiv kun eksplicit for at vælge et andet indekseret repo. Svaret viser, hvilket repo der blev brugt.
modeValgfri
Type
Literal[auto, hybrid, semantic, text, structural, ast, graph]
Standard
auto
Beskrivelse
Søgetilstand
limitValgfri
Type
int
Standard
10
Beskrivelse
Maks. antal resultater i dette rangerede top-K-vindue
language_filterValgfri
Type
str
Beskrivelse
Sprogfilter
path_filterValgfri
Type
str
Beskrivelse
Filtrer efter filstipræfiks
boost_by_importanceValgfri
Type
bool
Standard
Beskrivelse
Opt-in: omranger efter centralitet med symbolspecifikke grafmetrikker (is_articulation_point, bridge_count, k_core, centrality osv.). Slået fra som standard for agentsikker rangering (globale hubs kan drukne implementeringstræf); aktivér for arkitekturrundvisninger. Gælder for alle 4 modaliteter, når hvert resultat har symboltilknytning.
branchValgfri
Type
str
Beskrivelse
Tilsidesættelse af filial
qualityValgfri
Type
Literal[quick, balanced, thorough]
Standard
balanced
Beskrivelse
Forudindstillet søgekvalitet
include_contentValgfri
Type
bool
Standard
true
Beskrivelse
Inkluder indhold i resultaterne
explain_routingValgfri
Type
bool
Standard
Beskrivelse
Inkluder routingbeslutningsforklaring
importance_weightValgfri
Type
float
Standard
0.3
Beskrivelse
Vægt til vigtighedsforøgelse (0=ingen, 1=fuld)
orphansValgfri
Type
bool
Standard
Beskrivelse
Inkluder forældreløse symboler (ingen indgående referencer)
include_community_contextValgfri
Type
bool
Standard
Beskrivelse
Inkluder relaterede symboler fra samme kodefællesskab
community_depthValgfri
Type
int
Standard
1
Beskrivelse
Udvidelse af fællesskabskontekstens dybde
graph_viewValgfri
Type
Literal[dependency, type, data_flow, control_flow]
Standard
dependency
Beskrivelse
Grafvisning for metrics
seed_symbol_idsValgfri
Type
list[str]
Beskrivelse
Tier-1 opgavefrø: symbol-id'er, der er centrale for den aktuelle opgave. Når den er indstillet, omrangerer fusionerede hits ved Approach A dybde-decay-nærhed (nøjagtig seed-match + graf-kant-hop). Additiv — udelad for global rangering.
seed_file_pathsValgfri
Type
list[str]
Beskrivelse
Tier-1 opgavefrø: indekserede filstier, som agenten har åbnet eller lige har redigeret. Når den er indstillet, omrangerer fusionerede hits efter sti-nærhed med 1/(1+d) depth-decay (samme fil → samme dir → pakker i nærheden). Additiv — udelad for global rangering.

Bedst til:

  • Indeksomfattende eller cold-start-udforskning, når det er uklart, hvilket værktøj der er det rigtige
  • Multimodal, sammensmeltet rangering på tværs af semantisk, tekst, strukturel og graf

Anbefales ikke til:

  • Et kendt symbolnavn — brug find_symbol direkte
  • En kendt sti på disken — brug lokal Read/Grep først

Find kode efter betydning, ikke nøjagtig tekst. Brug dette til konceptuelle forespørgsler som "retry-logik" eller "brugerens onboardingflow", når du ikke kender nøgleordet eller symbolnavnet. Returnerer de mest relevante kodestykker rangeret efter vigtighed. Foretræk dette frem for Grep, når søgningen er konceptuel.

Parametre:

queryPåkrævet
Type
str
Beskrivelse
Søgeforespørgsel (konceptuel, meningsbaseret)
repositoryValgfri
Type
str
Beskrivelse
Repo som owner/repo[:branch]. Valgfrit — udelad for at bruge klientens standard for den aktuelle forespørgsel (hvis den er angivet) eller det eneste tilgængelige repo; angiv kun eksplicit for at vælge et andet indekseret repo. Svaret viser, hvilket repo der blev brugt.
limitValgfri
Type
int
Standard
5
Beskrivelse
Maks. antal resultater i dette rangerede top-K-vindue
similarity_thresholdValgfri
Type
float
Standard
0.6
Beskrivelse
Minimum lighedsscore
language_filterValgfri
Type
str
Beskrivelse
Sprogfilter (python, typescript osv.)
path_filterValgfri
Type
str
Beskrivelse
Filtrer efter filstipræfiks
boost_by_importanceValgfri
Type
bool
Standard
Beskrivelse
Opt-in: omranger efter PageRank-centralitet (slået fra som standard for agentsikker rangering; aktivér for arkitekturrundvisninger)
branchValgfri
Type
str
Beskrivelse
Grentilsidesættelse (standard: fra lagerparameter eller hoved)
include_contentValgfri
Type
bool
Standard
true
Beskrivelse
Inkluder klumpindhold i resultaterne
graph_viewValgfri
Type
Literal[dependency, type, data_flow, control_flow]
Standard
dependency
Beskrivelse
Grafvisning til metrikker

Bedst til:

  • Konceptuelle forespørgsler ("hvordan fungerer auth?", "cache-strategi")
  • Lighedssøgning på tværs af pakker

Anbefales ikke til:

  • Et kendt symbolnavn — brug find_symbol i stedet
  • Nøjagtige strenge eller fejlmeddelelser — brug text_pattern_search

Søg efter indekseret indhold. Præcis- og regex-tilstande grep hele filen/blob-korpuset; fuzzy content-tilstand søger i det afgrænsede semantiske chunk-korpus. Fil- og symbolomfang er kun fuzzy. Brug lokale Grep til en stram mappe, der allerede er på disken.

Parametre:

queryPåkrævet
Type
str
Beskrivelse
Tekstmønster at søge efter
repositoryValgfri
Type
str
Beskrivelse
Repo som owner/repo[:branch]. Valgfrit — udelad for at bruge klientens standard for den aktuelle forespørgsel (hvis den er angivet) eller det eneste tilgængelige repo; angiv kun eksplicit for at vælge et andet indekseret repo. Svaret viser, hvilket repo der blev brugt.
modeValgfri
Type
Literal[fuzzy, exact, regex]
Standard
exact
Beskrivelse
Søgetilstand
search_scopeValgfri
Type
Literal[content, symbols, files]
Standard
content
Beskrivelse
Hvad skal man søge
limitValgfri
Type
int
Standard
5
Beskrivelse
Maks. antal resultater returneret på denne side
offsetValgfri
Type
int
Beskrivelse
Forældet kompatibilitets-offset. Foretræk cursor fra pagination.next_cursor.
cursorValgfri
Type
str
Beskrivelse
Uigennemsigtig cursor fra pagination.next_cursor. Send den uændret, og hold query og filtre uændrede.
language_filterValgfri
Type
str
Beskrivelse
Sprogfilter
path_filterValgfri
Type
str
Beskrivelse
Filtrer efter filstipræfiks
case_sensitiveValgfri
Type
bool
Standard
Beskrivelse
Versalfølsom matching
branchValgfri
Type
str
Beskrivelse
Tilsidesættelse af filial
fuzzy_algorithmValgfri
Type
Literal[hybrid, trigram, levenshtein]
Standard
hybrid
Beskrivelse
Fuzzy matchende algoritme
thresholdValgfri
Type
float
Standard
0.05
Beskrivelse
Minimum lighedstærskel for fuzzy
semantic_fallbackValgfri
Type
bool
Standard
Beskrivelse
Gå tilbage til semantisk søgning, hvis ingen resultater

Bedst til:

  • Nøjagtige strenge, fejlmeddelelser og regex
  • Trigram fuzzy-matching til næsten-match-tekst

Anbefales ikke til:

  • En kendt sti på disken — foretræk lokal Grep
  • Konceptuelle forespørgsler — brug semantic_search

Strukturelle værktøjer & grafværktøjer#

Foretræk preset=functions|classes|methods|imports|variables (eller frit pattern=). Finder kode efter AST-form (ikke tekst). Filtre på mellemniveau: name_pattern, node_type, decorator, parent_child. Path-/ltree-/call-filtre er avancerede — sæt advanced=true, når du bruger dem bevidst; flade advanced-nøgler accepteres stadig af kompatibilitetshensyn. Angiv mindst én strukturel selector.

Parametre:

repositoryValgfri
Type
str
Beskrivelse
Repo som owner/repo[:branch]. Valgfrit — udelad for at bruge klientens standard for den aktuelle forespørgsel (hvis den er angivet) eller det eneste tilgængelige repo; angiv kun eksplicit for at vælge et andet indekseret repo. Svaret viser, hvilket repo der blev brugt.
presetValgfri
Type
Literal[functions, classes, methods, imports, variables]
Beskrivelse
Foretrukken strukturel selector. Udvides til sprogovergribende AST-nodetyper — functions (funktions-/pil-/metodedefinitioner på tværs af sprog); classes (class-/struct-/impl-definitioner); methods (metodedefinitioner, samt function_definition for sprog uden metodenode); imports (import-/use-/include-sætninger); variables (variable-/let-/const-/static-deklarationer). Foretræk frem for frit pattern/node_type til browse-lignende forespørgsler.
patternValgfri
Type
str
Beskrivelse
Free-form-mønster, når presets er for grove (registreres automatisk: 'def foo(' → node_type + name_pattern). Foretræk preset= til browse-forespørgsler.
name_patternValgfri
Type
str
Beskrivelse
Symbolnavnmønster (shell-wildcard, afgrænset POSIX-regex eller fuzzy tekst; maks. 256 tegn)
node_typeValgfri
Type
str
Beskrivelse
AST-nodetype (function_definition, class_definition osv.) — foretræk preset= til almindelige former
decoratorValgfri
Type
str
Beskrivelse
Filter for dekoratornavn
base_classValgfri
Type
str
Beskrivelse
Basisklasse filter
language_filterValgfri
Type
str
Beskrivelse
Sprogfilter (python, typescript osv.)
limitValgfri
Type
int
Standard
20
Beskrivelse
Maks. antal resultater returneret på denne side
offsetValgfri
Type
int
Beskrivelse
Forældet kompatibilitets-offset. Foretræk cursor fra pagination.next_cursor.
cursorValgfri
Type
str
Beskrivelse
Uigennemsigtig cursor fra pagination.next_cursor. Send den uændret, og hold query og filtre uændrede.
path_filterValgfri
Type
str
Beskrivelse
Filtrer efter filstipræfiks
branchValgfri
Type
str
Beskrivelse
Tilsidesættelse af filial
query_typeValgfri
Type
Literal[node_type, name_pattern, parent_child]
Beskrivelse
Eksplicit forespørgselstype
parent_typeValgfri
Type
str
Beskrivelse
Forælder AST node type filter
relationshipValgfri
Type
Literal[parent, ancestor]
Standard
parent
Beskrivelse
For parent_child-forespørgsler: Kun direkte overordnet eller enhver forfader (brug forfader til klassemetoder indlejret under en klasselegeme/blok)
has_modifierValgfri
Type
str
Beskrivelse
Filtrer efter modifikator (eksport, asynkron, statisk osv.)
advancedValgfri
Type
bool
Standard
Beskrivelse
Indstil true, når du med vilje bruger avancerede sti-, ltree- eller opkaldsfiltre (ltree_ancestor, ltree_descendant, min_depth, max_depth, field_role, definition_name, callee_text, callee_name). Som standard holder false agentgrænsefladen fokuseret på forudindstillinger. Avancerede nøgler i det flade format fungerer stadig for bagudkompatibilitet med en metadataadvarsel.
callee_textValgfri
Type
str
Beskrivelse
Avanceret — foretræk preset=functions|classes|methods|imports|variables. Filter for callee-tekst i et kaldudtryk. Sæt advanced=true, når du bevidst bruger path-/ltree-/call-filtre.
callee_nameValgfri
Type
str
Beskrivelse
Avanceret — foretræk preset=functions|classes|methods|imports|variables. Filter for callee-navn i et kaldudtryk. Sæt advanced=true, når du bevidst bruger path-/ltree-/call-filtre.
field_roleValgfri
Type
str
Beskrivelse
Avanceret — foretræk preset=functions|classes|methods|imports|variables. Filter for AST-feltrolle. Sæt advanced=true, når du bevidst bruger path-/ltree-/call-filtre.
ltree_ancestorValgfri
Type
str
Beskrivelse
Avanceret — foretræk preset=functions|classes|methods|imports|variables. Filter for AST-ltree-forfader-sti. Sæt advanced=true, når du bevidst bruger path-/ltree-/call-filtre.
ltree_descendantValgfri
Type
str
Beskrivelse
Avanceret — foretræk preset=functions|classes|methods|imports|variables. Filter for AST-ltree-efterkommer-sti. Sæt advanced=true, når du bevidst bruger path-/ltree-/call-filtre.
definition_nameValgfri
Type
str
Beskrivelse
Avanceret — foretræk preset=functions|classes|methods|imports|variables. Filter for definitionsnavn. Sæt advanced=true, når du bevidst bruger path-/ltree-/call-filtre.
min_depthValgfri
Type
int
Beskrivelse
Avanceret — foretræk preset=functions|classes|methods|imports|variables. Mindste AST-dybde. Sæt advanced=true, når du bevidst bruger path-/ltree-/call-filtre.
max_depthValgfri
Type
int
Beskrivelse
Avanceret — foretræk preset=functions|classes|methods|imports|variables. Højeste AST-dybde. Sæt advanced=true, når du bevidst bruger path-/ltree-/call-filtre.

Bedst til:

  • Struktur på AST-niveau: classes, decorators, function-/method-presets
  • Find kode efter form frem for tekst

Anbefales ikke til:

  • Fritekst eller konceptuelle forespørgsler — brug semantic_search eller intelligent_search

Primær påvirkningsradius-/grafoverflade. Svarer på "hvad kalder dette?" / "hvad bruger dette?" via den rigtige kalds-/importgraf. Til påvirkning før en ændring: analysis_type="dependents" eller analysis_type="impact" (indgående, 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 pr. sti og returnerer en kompakt, fladt indgående dependents-nyttelast uden krav om et symbolnavn. Sæt efter en ændring verify_after_edit=true med targets og/eller changed_paths til en kompakt multi-root genforespørgsel af berørte symboler. Understøtter også dependencies, centrality og orphans. analyze_dependencies er et tyndt alias for impact-stien — foretræk dette værktøj til nye agenter.

Parametre:

repositoryValgfri
Type
str
Beskrivelse
Repo som owner/repo[:branch]. Valgfrit — udelad for at bruge klientens standard for den aktuelle forespørgsel (hvis den er angivet) eller det eneste tilgængelige repo; angiv kun eksplicit for at vælge et andet indekseret repo. Svaret viser, hvilket repo der blev brugt.
queryValgfri
Type
str
Beskrivelse
Symbolnavn eller søgeterm
targetValgfri
Type
str
Beskrivelse
Symbolnavn (alias for forespørgsel)
changed_pathsValgfri
Type
list[str]
Beskrivelse
Repo-relative stier til PR/diff-påvirkning (standard) eller, med verify_after_edit=true, post-edit bekræftelsesrødder. PR/diff: løser symboler pr. sti og går lavvandede indkommende pårørende; kan kombineres med patch=. Bekræft: løser op til 5 symboler pr. sti som bekræftelsesrødder (afgrænset nederst i bekræftelsestilstand). Kræver ikke query/target for PR/diff-påvirkning.
patchValgfri
Type
str
Beskrivelse
PR/diff effekt: unified diff / git patch tekst. Stier er parset fra diff --git / --- / +++ overskrifter; samme kompakte stødbane som changed_paths.
analysis_typeValgfri
Type
Literal[centrality, dependencies, dependents, impact, orphans]
Standard
dependencies
Beskrivelse
Analysetilstand. impact = påvirkningsradius (indgående dependents; shallow dybde, når depth udelades). dependents besvarer også impact. Når changed_paths eller patch er angivet, tvinges analysen til PR-/diff-impact. centrality/orphans kræver ikke et target.
depthValgfri
Type
Literal[shallow, balanced, deep]
Standard
balanced
Beskrivelse
Traverseringsdybde. For analysis_type=impact og PR-/diff-impact er standardværdien reelt shallow, medmindre du angiver depth eksplicit.
limitValgfri
Type
int
Standard
20
Beskrivelse
Maks. antal resultater returneret på denne side
offsetValgfri
Type
int
Beskrivelse
Forældet kompatibilitets-offset. Foretræk cursor fra pagination.next_cursor.
cursorValgfri
Type
str
Beskrivelse
Uigennemsigtig cursor fra pagination.next_cursor. Send den uændret, og hold query og filtre uændrede.
path_filterValgfri
Type
str
Beskrivelse
Begrænser opløsning af målsymbolet til et filstiprefiks; returnerede grafrelationer kan række ud over den sti
language_filterValgfri
Type
str
Beskrivelse
Filtrerer målopløsning og browse-resultater efter sprog
directionValgfri
Type
Literal[outgoing, incoming, both]
Beskrivelse
Gennemløbsretning (tilsidesætter analysis_type-inferens)
relationship_typesValgfri
Type
list[str]
Beskrivelse
Filtrerer kanttyper (CALL, IMPORT, INHERITS_FROM osv.). En ikke-tom liste tilsidesætter graph_view-standardværdierne.
exclude_test_pathsValgfri
Type
bool
Standard
true
Beskrivelse
Standard true: udelukker test-, fixture-, vendor- og eksempelstier fra traverserings- og centralitetsresultater. Sæt false for at inkludere dem. Orphan-analysen anvender altid sine egne strengere støjudelukkelser.
exclude_generated_pathsValgfri
Type
bool
Standard
Beskrivelse
Ekskluder genererede erklæringer plus build, dækning, cache, kildekort og minificerede artefaktstier fra gennemløbsresultater
include_module_symbolsValgfri
Type
bool
Standard
Beskrivelse
Som standard ekskluderer false grafkanter, når from_name eller to_name er det syntetiske __module__-symbol (støj på modulniveau). Indstil true til at inkludere kanter på modulniveau i resultater for afhængigheds- og afhængighedsforhold.
branchValgfri
Type
str
Beskrivelse
Tilsidesættelse af filial
per_hop_limitValgfri
Type
int
Beskrivelse
Maks. antal relationer pr. hop (1-300)
include_metricsValgfri
Type
bool
Standard
Beskrivelse
Valgfrie grafmetrikker på resultatrækker (komprimeret med refactor_risk). Metrikker hentes også internt, når min_centrality>0, men returneres kun, 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 kurerede metriske sæt
include_edge_metadataValgfri
Type
bool
Standard
Beskrivelse
Inkluder rå kantmetadata og vægte (stor). Kompakte nyttelaster forlader dette.
symbol_typesValgfri
Type
list[str]
Beskrivelse
Filtrerer returnerede symboler efter type (function, class, method osv.)
exact_matchValgfri
Type
bool
Standard
Beskrivelse
Kræv nøjagtigt symbolnavn match
find_similar_patternsValgfri
Type
bool
Standard
Beskrivelse
Find lignende brugsmønstre
min_centralityValgfri
Type
float
Standard
0
Beskrivelse
Laveste PageRank-score. Metrikker hentes internt til filtrering; graph_metrics returneres kun, når include_metrics=true.
graph_viewValgfri
Type
Literal[dependency, type, data_flow, control_flow]
Standard
dependency
Beskrivelse
Grafvisning, der bruges til traverseringsrelationers standardværdier, metrikker og centralitetsrangering; orphan-analyse beregnes på tværs af alle visninger
verify_after_editValgfri
Type
bool
Standard
Beskrivelse
P2-7 post-edit verifikationstilstand: genforespørg den indekserede effektgraf for nyligt redigerede symboler i et kompakt multi-root svar. Kræver targets og/eller changed_paths (eller target/query). Standarder til overfladiske indkommende pårørende; resultater afspejler den indekserede graf (kan forsinke live-redigeringer). Når det er sandt, har den forrang frem for PR/diff indvirkning på den samme changed_paths.
targetsValgfri
Type
list[str]
Beskrivelse
Når verify_after_edit=true: symbolnavne, der skal genbekræftes (opkaldere/afhængige). Slået sammen med target/query, hvis begge er leveret.

Bedst til:

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

Anbefales ikke til:

  • Simple tekst- eller symbolopslag — brug text_pattern_search eller find_symbol

Kodeanalyseværktøjer#

find_symbolStabil

Hop til hvor en funktion, klasse eller variabel er defineret og brugt. Brug, når du kender navnet (f.eks. "getCurrentUser") - hurtigere og mere præcist end Grep, og det spænder over hele den indekserede repo. Returnerer eventuelt referencer og vigtighedsmetrics.

Parametre:

symbol_nameValgfri
Type
str
Beskrivelse
Symbolnavn, der skal søges efter (valgfrit — udelad for at gennemse efter metrics)
repositoryValgfri
Type
str
Beskrivelse
Repo som owner/repo[:branch]. Valgfrit — udelad for at bruge klientens standard for den aktuelle forespørgsel (hvis den er angivet) eller det eneste tilgængelige repo; angiv kun eksplicit for at vælge et andet indekseret repo. Svaret viser, hvilket repo der blev brugt.
scopeValgfri
Type
Literal[definitions, references, both]
Standard
both
Beskrivelse
Søgeomfang
limitValgfri
Type
int
Standard
15
Beskrivelse
Maks. antal resultater returneret på denne side
offsetValgfri
Type
int
Beskrivelse
Forældet kompatibilitets-offset. Foretræk cursor fra pagination.next_cursor.
cursorValgfri
Type
str
Beskrivelse
Uigennemsigtig cursor fra pagination.next_cursor. Send den uændret, og hold query og filtre uændrede.
find_similarValgfri
Type
bool
Standard
Beskrivelse
Medtag lignende symbolnavne
include_metricsValgfri
Type
bool
Standard
Beskrivelse
Inkluder centralitetsmålinger
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 kurerede metriske sæt
path_filterValgfri
Type
str
Beskrivelse
Filtrer efter filstipræfiks
branchValgfri
Type
str
Beskrivelse
Tilsidesættelse af filial
symbol_typeValgfri
Type
Literal[function, class, variable, method, constant, module, interface, type]
Beskrivelse
Filtrer efter symboltype
high_impactValgfri
Type
bool
Standard
Beskrivelse
Gennemse arkitektonisk vigtige symboler (udelad symbol_name). Standardtilstand er popularity (øverste PageRank-decil minus utility-megahubs). Sæt high_impact_mode=risk til artikulations-/bridge-skæringspunkter.
high_impact_modeValgfri
Type
Literal[popularity, risk]
Standard
popularity
Beskrivelse
Når high_impact=true: popularitet = top PageRank decil minus utility mega-hubs/moduler; risiko = artikulationspoint rangeret efter SMV bridge_count derefter k_core (strukturel refaktorrisiko, ikke hub-popularitet)
in_cycleValgfri
Type
bool
Standard
Beskrivelse
Filtrer til symboler i afhængighedscyklusser
exclude_test_pathsValgfri
Type
bool
Standard
true
Beskrivelse
Når du browser efter grafmetrikker, skal du ekskludere test, fixtures, tredjepartskode og eksempler før rangering. Opslag efter et navngivet symbol er uændret.

Bedst til:

  • Fastlåsning af et kendt symbols definition, referencer og grafmetrics
  • Gennemse efter centrality, high_impact eller in_cycle, når symbol_name udelades

Anbefales ikke til:

  • Konceptuelle forespørgsler eller forespørgsler i ukendt område — brug intelligent_search eller semantic_search

analyze_dependenciesStabil

Alias for påvirkningsradius via dependency_search (dependents/incoming). Foretræk dependency_search med analysis_type="dependents" eller "impact" til nye agenter. Bevarer den gamle multi-hop impact-svarform (graph, connection_summary, valgfrie metrikker med refactor_risk). Brug graph_view til at afgrænse relationsfamilien: dependency (standard), type, data_flow, control_flow.

Parametre:

repositoryValgfri
Type
str
Beskrivelse
Repo som owner/repo[:branch]. Valgfrit — udelad for at bruge klientens standard for den aktuelle forespørgsel (hvis den er angivet) eller det eneste tilgængelige repo; angiv kun eksplicit for at vælge et andet indekseret repo. Svaret viser, hvilket repo der blev brugt.
targetPåkrævet
Type
str
Beskrivelse
Symbolnavn at analysere
depthValgfri
Type
Literal[shallow, balanced, deep]
Standard
balanced
Beskrivelse
Analyse dybde
limitValgfri
Type
int
Standard
10
Beskrivelse
Maks. antal resultater returneret på denne side
offsetValgfri
Type
int
Beskrivelse
Forældet kompatibilitets-offset. Foretræk cursor fra pagination.next_cursor.
cursorValgfri
Type
str
Beskrivelse
Uigennemsigtig cursor fra pagination.next_cursor. Send den uændret, og hold query og filtre uændrede.
directionValgfri
Type
Literal[incoming, outgoing, both]
Standard
incoming
Beskrivelse
Gennemløbsretning
relationship_typesValgfri
Type
list[str]
Beskrivelse
Filterkanttyper (CALL, IMPORT, INHERITS_FROM osv.). Tilsidesætter altid den graph_view-afledte standard nedenfor, når den leveres.
graph_viewValgfri
Type
Literal[dependency, type, data_flow, control_flow]
Standard
dependency
Beskrivelse
Grafvisning: bestemmer både standardkrydsningskanttyperne og hvilken visnings metrics, der bruges, 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]. Anvendes kun som relationship_types-standard, når relationship_types ikke er eksplicit leveret. Matcher dependency_search's eksisterende graph_view parameternavn for konsistens på tværs af værktøjer.
path_filterValgfri
Type
str
Beskrivelse
Begrænser opløsning af målsymbolet til et filstiprefiks; returnerede grafrelationer kan række ud over den sti
language_filterValgfri
Type
str
Beskrivelse
Sprog filter
branchValgfri
Type
str
Beskrivelse
Tilsidesættelse af filial
per_hop_limitValgfri
Type
int
Beskrivelse
Maks. antal relationer pr. hop (1-300)
include_metricsValgfri
Type
bool
Standard
Beskrivelse
Inkluder grafmetrikker i resultater, hver beriget med en afledt refactor_risk-blok ({risk: "low"|"medium"|"high", is_articulation_point, bridge_count, k_core, graph_view, reasons}). risiko er "low", når det ikke er et artikulationspunkt (i den valgte visning), "medium" når et artikulationspunkt, der bygger bro over få kanter, "high" ved bro over mange (heuristisk tærskel, ikke empirisk valideret). Udeladt pr. symbol, når der ikke findes nogen metric-række for det pågældende symbol/den pågældende visning.
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 kurerede metriske sæt
include_edge_metadataValgfri
Type
bool
Standard
Beskrivelse
Inkluder rå kantmetadata og vægte. Deaktiveret som standard, fordi ekstraktionsmetadata kan være store; berigelsesdækning rapporteres, når den er aktiveret.
exclude_test_pathsValgfri
Type
bool
Standard
true
Beskrivelse
Standard true: ekskluder test-, fixtur-, leverandør- og eksempelstier fra returnerede grafkanter. Indstil false til at 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__-symbol. Indstil true til at inkludere kanter på modulniveau.

Bedst til:

  • Ældre kaldere, der allerede er forbundet til dens svarform (graph, connection_summary)

Anbefales ikke til:

  • Nye agent-loops — foretræk dependency_search, som deler samme traversal-kerne

get_task_contextStabil

Starter du arbejde i et ukendt område? Beskriv opgaven (f.eks. "tilføj SSO-understøttelse", "ret faktureringswebhooken") og få en afgrænset pakke med relevante filer, kode, symboler og afhængigheder tilbage i ét kald. Seed-filer bidrager med direkte indekseret indhold, selv når de ikke definerer symboler. Fortsæt med det specialiserede søgeværktøj til det pågældende lag for flere resultater.

Parametre:

task_descriptionPåkrævet
Type
str
Beskrivelse
Beskrivelse af den opgave du skal bruge kontekst til
repositoryValgfri
Type
str
Beskrivelse
Repo som owner/repo[:branch]. Valgfrit — udelad for at bruge klientens standard for den aktuelle forespørgsel (hvis den er angivet) eller det eneste tilgængelige repo; angiv kun eksplicit for at vælge et andet indekseret repo. Svaret viser, hvilket repo der blev brugt.
limitValgfri
Type
int
Standard
15
Beskrivelse
Maksimalt antal resultater pr. lag
scopeValgfri
Type
Literal[semantic, symbols, dependencies, all]
Standard
all
Beskrivelse
Hvilke kontekstlag skal inkluderes
language_filterValgfri
Type
str
Beskrivelse
Sprog filter
path_filterValgfri
Type
str
Beskrivelse
Filtrer efter filstipræfiks
branchValgfri
Type
str
Beskrivelse
Tilsidesættelse af filial
include_related_contextValgfri
Type
bool
Standard
Beskrivelse
Inkluder relateret kontekst fra tilstødende symboler
seed_symbol_idsValgfri
Type
list[str]
Beskrivelse
Eksplicitte Tier-1-seeds: symbol-id'er, som agenten allerede ved er centrale for opgaven (f.eks. symboler i filer, den har åbne). Rangeres foran søgeordsafledte seeds i lagene dependencies/related_context. Dette er additivt — udelad for at bevare den nuværende adfærd med kun søgeord.
seed_file_pathsValgfri
Type
list[str]
Beskrivelse
Tier-1-eksplicitte seeds: indekserede filstier, som agenten har åbne eller lige har redigeret. Returnerer afgrænset direkte fildokumentation og opløser op til 5 symboler pr. fil til grafkontekst, inklusive symbolfri dokumentation og konfiguration. Additiv — udelad for en ren nøgleordsbaseret adfærd.

Bedst til:

  • Opgavebevidst kontekst, der blander seed-filer med semantiske, symbol- og afhængighedslag

Anbefales ikke til:

  • Opslag med ét værktøj, hvor et mere specifikt værktøj allerede besvarer spørgsmålet

get_fileStabil

Læser en fil fra det indekserede repo efter sti. Foretræk det lokale Read-værktøj til filer på disken — brug dette til opslag i andre repoer eller fjernopslag, når filen ikke findes i dit arbejdstræ. Understøtter et valgfrit linjeinterval; fortsæt et token-afkortet svar fra metadata.next_line_start.

Parametre:

file_pathPåkrævet
Type
str
Beskrivelse
Filsti i forhold til lagerroden
repositoryValgfri
Type
str
Beskrivelse
Repo som owner/repo[:branch]. Valgfrit — udelad for at bruge klientens standard for den aktuelle forespørgsel (hvis den er angivet) eller det eneste tilgængelige repo; angiv kun eksplicit for at vælge et andet indekseret repo. Svaret viser, hvilket repo der blev brugt.
line_startValgfri
Type
int
Beskrivelse
Startlinje (1-indekseret)
line_endValgfri
Type
int
Beskrivelse
Slutlinje (1-indekseret, inklusive; skal være ved eller efter line_start)
branchValgfri
Type
str
Beskrivelse
Tilsidesættelse af filial
max_tokensValgfri
Type
int
Standard
5000
Beskrivelse
Maksimalt antal tokens at returnere
include_metadataValgfri
Type
bool
Standard
true
Beskrivelse
Inkluder filmetadata som svar

Bedst til:

  • Eksterne eller indekserede filøjebliksbilleder (linjeintervaller, tokengrænser)

Anbefales ikke til:

  • En sti, der allerede er på den lokale disk — brug det lokale Read-værktøj

System- og hjælpeværktøjer#

repository_contextStabil

Lister de repoer, du kan søge i, eller henter identitetsoplysninger om ét repo (namespace/branch, indexed_commit_sha / indeksets aktualitet). Kald action:"list" én gang for at se den præcise repo-slug, som søgeværktøjerne accepterer. (Hvis din nøgle kun har ét repo, bruger søgeværktøjerne det som standard — så kan du springe dette over.) Namespace-brede fil-/blob-/kant-optællinger er valgfrie via include_statistics=true.

Parametre:

actionPåkrævet
Type
Literal[list, info]
Beskrivelse
Handling: list for at vise tilgængelige repo eller info for at hente repooplysninger
repositoryValgfri
Type
str
Beskrivelse
Repository i formatet owner/repo eller owner/repo:branch (påkrævet for info)
branchValgfri
Type
str
Beskrivelse
Tilsidesættelse af filial
patternValgfri
Type
str
Beskrivelse
Filtrer lagerliste efter mønster
include_statisticsValgfri
Type
bool
Standard
Beskrivelse
Opt-in: inkluderer namespace-brede optællinger af indekserede data (fil/blob/kant). Standard false — repoets identitet kræver ikke dette langsommere aggregat.
limitValgfri
Type
int
Standard
20
Beskrivelse
Maks. antal resultater returneret på denne side
offsetValgfri
Type
int
Beskrivelse
Forældet kompatibilitetsforskydning. Foretrækker cursor fra pagination.next_cursor.
cursorValgfri
Type
str
Beskrivelse
Uigennemsigtig cursor fra pagination.next_cursor. Send den uændret, og behold forespørgslen og filtrene uændrede.

Bedst til:

  • Angivelse af tilgængelige repoer
  • Fastlæggelse af repo-identitet, branch og HEAD-kontra-indeks-friskhed

Anbefales ikke til:

  • Namespace-brede statistikker som standard — angiv include_statistics=true eksplicit, da det kan være langsommere end opløsning

ask_maguyvaStabil

Hjælp og feedback til Maguyva. Primært: få værktøjsvejledning, eller indsend en fejlrapport / funktionsanmodning, der gemmes til Maguyvas vedligeholdere. Medtag aldrig hemmeligheder eller følsomme personoplysninger i feedback. operationen evaluate findes kun af hensyn til bagudkompatibilitet — foretræk lokal beregning eller værtsværktøjer til matematik-/hash-/strengarbejde.

Parametre:

operationPåkrævet
Type
Literal[guidance, report_bug, request_feature, evaluate]
Beskrivelse
Primært: guidance, report_bug, request_feature. Kun legacy/kompatibilitet: evaluate (deterministisk udtryksmotor; ikke en del af den primære agent-arbejdsgang).
queryValgfri
Type
str
Beskrivelse
Vejledningsemne (f.eks. tool_selection, semantic_search). Kun til legacy evaluate: udtryksstreng.
descriptionValgfri
Type
str
Beskrivelse
Påkrævet for report_bug og request_feature. Free-form-feedback til Maguyva-vedligeholdere. Medtag aldrig hemmeligheder eller følsomme personoplysninger.
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
Valgfrit Maguyva-værktøj, der er tættest relateret til feedback

Bedst til:

  • Værktøjsvejledning (operation="guidance")
  • Varige fejlrapporter og funktionsanmodninger til vedligeholderne af Maguyva

Anbefales ikke til:

  • Matematik-/hash-/strengberegning — operationen evaluate findes kun af hensyn til bagudkompatibilitet; foretræk lokal værtsberegning

Bedste praksis#

  1. Brug eksplicitte tilsidesættelser bevidst: Udelad repoet, når MCP-klienten angiver en standard for den aktuelle forespørgsel, eller når nøglen har adgang til præcis ét repo; angiv det ellers eksplicit.
  2. Vælg den rigtige søgetilstand: Brug intelligent_search med mode="auto" i de fleste tilfælde. Angiv en tilstand, når du ved præcis, hvad du har brug for.
  3. Udnyt sprogfiltre: Brug language_filter til at indsnævre resultater og forbedre ydeevnen.
  4. GraphRAG Boosting: GraphRAG-vigtighedsboosting er slået fra som standard for semantisk søgning (boost_by_importance=false) for at holde rangeringen agent-sikker. Send boost_by_importance=true for at aktivere centralitetsbevidst omrangering til arkitekturgennemgange.
  5. Repository-matchning skelner ikke mellem store/små bogstaver, men er ikke fuzzy: repository_context matcher repository-navne uafhængigt af store/små bogstaver — den retter ikke stavefejl. Tjek metadata.resolution_reason på info-handlingen ("exact" versus "corrected") for at se, hvordan et navn blev matchet.
  6. Kombiner værktøjer: Brug flere API-metoder sammen til en omfattende analyse.
  7. Håndter store resultater: Brug limit og værktøjsspecifikke pagineringskontroller (for eksempel line_start/line_end i get_file).
  8. Brug ask_maguyva til værktøjsvejledning: ask_maguyvas evaluate-handling (hash, base64, JSON, matematik) er kun legacy / bagudkompatibilitet. Kald i stedet ask_maguyva med operation="guidance" og query="tool_selection" for local-tool-wins-matrixen og et komplet værktøj-for-værktøj snydeark.
  9. Verificer konsekvenser før og efter redigering: Før du redigerer et delt symbol, skal du kalde dependency_search med analysis_type="impact" (eller sende changed_paths for PR-/diff-konsekvens) for at se dets konsekvensradius. Efter redigering skal du sætte verify_after_edit=true med targets og/eller changed_paths for et kompakt genkontrol af de samme symboler.

Ydeevneegenskaber#

OperationPerformance-noter
Semantisk søgningUnder et sekund, men inkluderer hver gang et live embedding-API-kald (caches ikke) — forvent ekstra latenstid oven i vektorforespørgslen
TekstsøgningUnder et sekund for eksakt/regex; fuzzy fritekstsøgning paginerer på klientsiden, så dybe offsets koster mere — indsnævr med path_filter/language_filter
Strukturel søgningAST-indekseret — omkostningen skalerer med resultatmængden, ikke med repository-størrelsen
AfhængighedssøgningOmkostningen skalerer med dybden — foretræk depth="shallow", medmindre du har brug for kontekst med flere hop; per_hop_limit begrænser spredningen
FilhentningNæsten øjeblikkelig for en enkelt fil — inddel store filer med line_start/line_end eller max_tokens i stedet for ét stort træk
Repository-kontekstNamespace-opløsning caches kun pr. forespørgsel, ikke på tværs af kald — hvert værktøjskald løses igen
ask_maguyva (guidance / evaluate)Næsten øjeblikkelig — kører in-Worker uden databasekald

Fejlhåndtering#

Alle API-metoder returnerer en struktureret konvolut:

  • status: Streng — "success" eller "error". Signaler om forringet match eller friskhed findes i indlejrede felter som metadata.resolution_reason på repository_context eller metadata.index_freshness.status.
  • tool: Navnet på det værktøj, der genererede svaret
  • data: Resultatpayload ved succes (struktur varierer efter værktøj)
  • error: Struktureret fejlobjekt, når status er "error" — inkluderer type, message, suggestions og recovery_actions
  • metadata: Yderligere information om operationen (routing, caching, parameterjusteringer)
  • pagination: Findes på listesvar — inkluderer has_more og next_cursor

Tjek altid feltet status, før du behandler resultater — det er kun enten "success" eller "error". For signaler om forringet match eller friskhed skal du i stedet læse det indlejrede felt: metadata.resolution_reason på repository_context, eller metadata.index_freshness.status (known/partial/unknown/unavailable).

Kom i gang#

  1. Konfigurer MCP Client: Ret din MCP-klient til Maguyva-serverens slutpunkt
  2. Bekræft lageradgang: Brug repository_context med liste eller info til at inspicere lagre, der er tilgængelige for API-nøglen
  3. Begynd at søge: Begynd med intelligent_search og udforsk specialiserede værktøjer efter behov
  4. Kombiner værktøjer: Brug flere værktøjer sammen til omfattende kodeanalyse

Se installationsguide for detaljerede integrationsinstruktioner.