Siirry sisältöön

MCP API -referenssi

Tutustu Maguyva-palvelun 11 MCP-työkaluun, niiden parametreihin ja käyttötarkoituksiin. Tarkista käytettävissä olevat argumentit yhdistetyn asiakasohjelman tools/list-vastauksesta.

API-yleiskatsaus

#

Työkalut on jaettu 4 luokkaan:

  • Ydinhakutyökalut - Kehittyneet hakuominaisuudet koko koodikannassasi
  • Rakenne- ja graafityökalut - AST-kyselyt, symbolihaku ja riippuvuusanalyysi
  • Koodianalyysityökalut - Syvällinen koodianalyysi ja suhteiden kartoitus
  • Järjestelmä- ja apuohjelmatyökalut - Repositorion konteksti, työkaluohjeet ja palaute

Repositorion hyväksyvissä työkaluissa repositoriotunnisteen muoto on "owner/repo:branch". Haaran oletus on main, jos sitä ei määritetä.

Jätä repository pois, kun MCP-asiakas antaa pyyntökohtaisen oletuksen tai kun avaimella on pääsy täsmälleen yhteen repositoryyn; muussa tapauksessa anna se erikseen. Tarkista komennolla repository_context(action="info", repository="owner/repo"), miten repositorio tunnistetaan.

Repositorioparametrin muoto

#

Käytä näitä muotoja repositorion määrittämiseen:

  • Haara mukana: "owner/repo:branch" - esim., "owner/repository:develop"
  • Oletushaara: "owner/repo" - käyttää main-haaraa, kun haaraa ei ole määritetty "owner/repository"
  • Pyyntökohtainen tai ainoan repositoryn oletus: Jätä repository pois, kun MCP-asiakas antaa pyyntökohtaisen oletuksen tai kun avaimella on pääsy täsmälleen yhteen repositoryyn; muussa tapauksessa anna se erikseen

Esimerkkikehotteet:

Kysy tietystä reposta:              "Hae todennuksen väliohjelmistoa owner/my-repo"
Listaa käytettävissä olevat repot:  "Mihin repositorioihin tällä Maguyva-avaimella on pääsy?"
Yhden kyselyn ohitus:               "Hae todennusmalleja owner/other-repo:develop"

Kielisuodatus

#

Käytä parametria language_filter sitä tukevissa hakutiloissa. Valitse työkalulle text_pattern_search search_scope="content"; käytä työkalulle get_task_context asetusta scope="semantic" ilman lähtöpisteitä tai liittyvää kontekstia.

  • language_filter="python" - Suodata vain Python-tiedostoihin
  • language_filter="typescript" - Suodata vain TypeScript-tiedostoihin
  • Kirjainkoko merkitsee: Käytä kielten nimiä pienillä kirjaimilla
  • Oletus: Tyhjä merkkijono (ei suodatusta) - palauttaa tuloksia kaikista kielistä
  • Tuettu kattavuus: Kielisuodattimet kattavat kaikki 285+ tuettua kieltä ja tekstipohjaisia teknologioita. Katso täydellinen luettelo kohdasta yhteensopivuus. 
"Etsi autentikointi-middlewarea vain Python-tiedostoista"
"Etsi tietokantayhteyksiä TypeScript-koodista"

API-referenssi luotu lähdekoodista 21. lokakuuta 2026.

Ydinhakutyökalut

#

intelligent_search Vakaa

Aloita tästä kaikissa koodikantaa koskevissa kysymyksissä. Oletusarvoinen auto/balanced ohjaa suurella varmuudella määritelmien hauiksi tunnistetut kyselyt rakenteelliseen hakuun, viittaus- tai vaikutuskyselyt graafihakuun ja tarkkaa osumaa hakevat kyselyt tekstihakuun. Muut kyselyt käyttävät semanttista merkitystä ja indeksoitua tekstiä. Pyydä kaikkia neljää hakumenetelmää valinnalla mode=hybrid tai auto ja quality=thorough. Erikseen valittu tila on ensisijainen quality-asetukseen nähden. language_filter jättää graafin pois auto/hybrid-haussa ja hylätään, kun mode=graph on valittu erikseen. Suosi tätä työkalua Grep/Glob-hakujen sijaan, jos et vielä tiedä polkua.

Parametrit:

query Pakollinen
Tyyppi
str minLength=1
Kuvaus
Hakukysely
repository Valinnainen
Tyyppi
str
Kuvaus
Repository muodossa owner/repo[:branch]. Valinnainen — jätä pois käyttääksesi asiakkaan pyyntökohtaista oletusta (jos annettu) tai ainoaa käytettävissä olevaa repositorya; anna erikseen vain valitaksesi toisen indeksoidun repon. Tarkasti indeksoituja haaroja suositaan; jos haara ei ole käytettävissä, se voi palautua haaraan main tai ainoaan käytettävissä olevaan haaraan. Vastauksen metatiedot näyttävät pyydetyn ja tosiasiassa käytetyn identiteetin ja varoittavat tällaisesta palautumisesta.
mode Valinnainen
Tyyppi
Literal[auto, hybrid, semantic, text, structural, ast, graph]
Oletus
auto
Kuvaus
Hakutila
limit Valinnainen
Tyyppi
int minimum=1, maximum=50
Oletus
10
Kuvaus
Enimmäistulosmäärä tässä järjestetyssä top-K-ikkunassa
language_filter Valinnainen
Tyyppi
str
Kuvaus
Kielisuodatin
path_filter Valinnainen
Tyyppi
str
Kuvaus
Suodattaa hakuehdokkaat tiedostopolun etuliitteen perusteella. Graafin naapurisolmut ja liitetty yhteisökonteksti voivat sisältää tiedostoja tämän etuliitteen ulkopuolelta.
boost_by_importance Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Opt-in: järjestä uudelleen keskeisyyden mukaan käyttäen symbolikohtaisia graafimittareita (is_articulation_point, bridge_count, k_core, centrality jne.). Oletuksena pois päältä agentin kannalta turvallista järjestystä varten (globaalit solmukohdat voivat hukuttaa toteutusosumat); ota käyttöön arkkitehtuurikierroksia varten. Koskee kaikkia 4 modaliteettia, kun jokaisella tuloksella on symbolikytkentä.
branch Valinnainen
Tyyppi
str
Kuvaus
Haaran ohitus
quality Valinnainen
Tyyppi
Literal[quick, balanced, thorough]
Oletus
balanced
Kuvaus
Haun laadun esiasetus
include_content Valinnainen
Tyyppi
bool
Oletus
true
Kuvaus
Sisällytä sisältö tuloksiin
explain_routing Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Sisällytä reitityspäätöksen selitys
importance_weight Valinnainen
Tyyppi
float minimum=0, maximum=1
Oletus
0.3
Kuvaus
Tärkeyden lisäämisen paino (0 = ei mitään, 1 = täysi)
orphans Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Sisällytä orvot symbolit (ei saapuvia viittauksia)
include_community_context Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Sisällytä samaan koodiyhteisöön liittyvät symbolit
community_depth Valinnainen
Tyyppi
int minimum=1, maximum=3
Oletus
1
Kuvaus
Yhteisön kontekstin laajenemisen syvyys
graph_view Valinnainen
Tyyppi
Literal[dependency, type, data_flow, control_flow]
Oletus
dependency
Kuvaus
Graafinäkymä mittareille
seed_symbol_ids Valinnainen
Tyyppi
list[str] maxItems=20
Kuvaus
Tier-1-tehtävän lähtöpisteet: nykyiselle tehtävälle keskeisten symbolien tunnisteet. Kun annettu, yhdistetyt osumat järjestetään uudelleen Approach A -menetelmän syvyyden myötä vaimenevan läheisyyden perusteella (tarkka lähtöpisteosuma + graafin kaaria pitkin lasketut askeleet). Valinnainen lisäys — jätä pois, jos haluat globaalin järjestyksen.
seed_file_paths Valinnainen
Tyyppi
list[str] maxItems=10
Kuvaus
Tier-1-tehtävän lähtöpisteet: indeksoidut tiedostopolut, jotka agentti on avannut tai joita se juuri muokkasi. Kun annettu, yhdistetyt osumat järjestetään uudelleen polkujen läheisyyden perusteella vaimennuksella 1/(1+d) (sama tiedosto → sama hakemisto → läheiset paketit). Valinnainen lisäys — jätä pois, jos haluat globaalin järjestyksen.

Parhaiten sopii:

  • Koko indeksin laajuinen tai kylmäkäynnistyksen tutkiminen, kun oikea työkalu ei ole selvä
  • Monimodaalinen yhdistetty pisteytys semanttisen, tekstin, rakenteellisen ja graafin välillä

Ei suositella:

  • Tunnettu symbolin nimi — käytä suoraan find_symbol-työkalua
  • Tunnettu polku levyllä — käytä ensin paikallista Read/Grep-työkalua

semantic_search Vakaa

Etsi koodia merkityksen, ei täsmällisen tekstin perusteella. Käytä käsitteellisiin kyselyihin, kuten ”uudelleenyrityslogiikka” tai ”käyttäjän perehdytyspolku”, kun et tiedä avainsanaa tai symbolin nimeä. Palauttaa olennaisia katkelmia, joiden tiedostovalikoima on rajattu; graafitärkeyteen perustuva uudelleenjärjestys otetaan erikseen käyttöön boost_by_importance-parametrilla. Suosi tätä Grep-työkalun sijaan käsitteellisissä hauissa.

Parametrit:

query Pakollinen
Tyyppi
str minLength=1
Kuvaus
Hakulauseke (käsitteellinen, merkityksellinen)
repository Valinnainen
Tyyppi
str
Kuvaus
Repository muodossa owner/repo[:branch]. Valinnainen — jätä pois käyttääksesi asiakkaan pyyntökohtaista oletusta (jos annettu) tai ainoaa käytettävissä olevaa repositorya; anna erikseen vain valitaksesi toisen indeksoidun repon. Tarkasti indeksoituja haaroja suositaan; jos haara ei ole käytettävissä, se voi palautua haaraan main tai ainoaan käytettävissä olevaan haaraan. Vastauksen metatiedot näyttävät pyydetyn ja tosiasiassa käytetyn identiteetin ja varoittavat tällaisesta palautumisesta.
limit Valinnainen
Tyyppi
int minimum=1, maximum=50
Oletus
5
Kuvaus
Enimmäistulosmäärä tässä järjestetyssä top-K-ikkunassa
similarity_threshold Valinnainen
Tyyppi
float minimum=0, maximum=1
Oletus
0.6
Kuvaus
Minimi samankaltaisuuspisteet
language_filter Valinnainen
Tyyppi
str
Kuvaus
Kielisuodatin (python, typescript jne.)
path_filter Valinnainen
Tyyppi
str
Kuvaus
Suodata tiedostopolun etuliitteen mukaan
boost_by_importance Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Valinnainen: järjestä uudelleen kunkin symbolin normalisoidun graafitärkeyden perusteella (oletuksena pois; enintään 1,5 kertaa samankaltaisuus).
branch Valinnainen
Tyyppi
str
Kuvaus
Haaran ohitus (oletus: repository-parametrista tai main)
include_content Valinnainen
Tyyppi
bool
Oletus
true
Kuvaus
Sisällytä tuloksiin sisältökatkelmat
graph_view Valinnainen
Tyyppi
Literal[dependency, type, data_flow, control_flow]
Oletus
dependency
Kuvaus
Graafinäkymä mittareita varten

Parhaiten sopii:

  • Käsitteelliset kyselyt (esim. "miten todennus toimii?", "välimuististrategia")
  • Pakettien välinen samankaltaisuushaku

Ei suositella:

  • Tunnettu symbolin nimi — käytä sen sijaan find_symbol-työkalua
  • Tarkat merkkijonot tai virheilmoitukset — käytä text_pattern_search-työkalua

text_pattern_search Vakaa

Hae indeksoitua sisältöä. exact ja regex käyttävät grep-hakua koko tiedosto-/blob-korpukseen; fuzzy content hakee rajatusta semanttisten katkelmien korpuksesta. file- ja symbol-alueet tukevat vain trigrammeja — oletus mode=exact muunnetaan fuzzy-tilaksi. Kielen, kirjainkoon ja oman kynnysarvon säätö edellyttää content-aluetta. Tiedostopolkujen suodatus käyttää rajattua ehdokasikkunaa ja ilmoittaa puutteellisesta kattavuudesta. Käytä paikallista Grep-työkalua suppeaan hakemistoon, joka on jo levyllä.

Parametrit:

query Pakollinen
Tyyppi
str minLength=1
Kuvaus
Haettava tekstikuvio
repository Valinnainen
Tyyppi
str
Kuvaus
Repository muodossa owner/repo[:branch]. Valinnainen — jätä pois käyttääksesi asiakkaan pyyntökohtaista oletusta (jos annettu) tai ainoaa käytettävissä olevaa repositorya; anna erikseen vain valitaksesi toisen indeksoidun repon. Tarkasti indeksoituja haaroja suositaan; jos haara ei ole käytettävissä, se voi palautua haaraan main tai ainoaan käytettävissä olevaan haaraan. Vastauksen metatiedot näyttävät pyydetyn ja tosiasiassa käytetyn identiteetin ja varoittavat tällaisesta palautumisesta.
mode Valinnainen
Tyyppi
Literal[fuzzy, exact, regex]
Oletus
exact
Kuvaus
Hakutila. Regex suorittaa PostgreSQL:n edistyneen/POSIX-syntaksin; käytä \y sananrajoihin (\b tarkoittaa askelpalautinta). Kuviot läpäisevät myös JavaScript-turvallisuusvalidaattorin, joten pelkästään PostgreSQL:lle ominaiset rakenteet, kuten sisäiset (?i)-liput, hylätään; käytä sen sijaan case_sensitive-parametria.
search_scope Valinnainen
Tyyppi
Literal[content, symbols, files]
Oletus
content
Kuvaus
Mitä etsiä
limit Valinnainen
Tyyppi
int minimum=1, maximum=50
Oletus
5
Kuvaus
Enimmäistulosmäärä sivua kohden ilman cursoria. Jatkaminen käyttää cursoriin tallennettua sivukokoa; jätä cursor pois, jos haluat aloittaa eri limit-arvolla.
offset Valinnainen
Tyyppi
int minimum=0
Kuvaus
Vanhentunut yhteensopivuus-offset. Suosi cursoria kohteesta pagination.next_cursor.
cursor Valinnainen
Tyyppi
str
Kuvaus
Läpinäkymätön cursor kohteesta pagination.next_cursor. Välitä se muuttumattomana ja pidä query ja suodattimet muuttumattomina. Sen sijainti ja sivukoko ohittavat offset- ja limit-arvot.
language_filter Valinnainen
Tyyppi
str
Kuvaus
Kielisuodatin
path_filter Valinnainen
Tyyppi
str
Kuvaus
Suodata tiedostopolun etuliitteen mukaan
case_sensitive Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Kirjainkoon erottelu
branch Valinnainen
Tyyppi
str
Kuvaus
Haaran ohitus
fuzzy_algorithm Valinnainen
Tyyppi
Literal[hybrid, trigram, levenshtein]
Oletus
hybrid
Kuvaus
Sumea sovitusalgoritmi
threshold Valinnainen
Tyyppi
float minimum=0, maximum=1
Oletus
0.05
Kuvaus
Samankaltaisuuden vähimmäiskynnys sumealle haulle
semantic_fallback Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Yrittää semanttista hakua tyhjän ensimmäisen leksikaalisen sivun jälkeen; metadata.fallback_status erottaa varajärjestelmän tilat used, empty ja unavailable.

Parhaiten sopii:

  • Tarkat merkkijonot, virheilmoitukset ja regex
  • Trigram-fuzzy-haku lähes osuvalle tekstille

Ei suositella:

  • Tunnettu polku levyllä — suosi paikallista Grep-työkalua
  • Käsitteelliset kyselyt — käytä semantic_search-työkalua

Rakenne- ja graafityökalut

#

structural_search Vakaa

Suosi asetusta preset=functions|classes|methods|imports|variables (tai vapaata pattern=). Hae koodia AST-rakenteen, ei tekstin perusteella. Keskitason suodattimet: name_pattern, node_type, decorator, parent_child. Polku-/ltree-/kutsusuodattimet ovat edistyneitä; aseta advanced=true, kun käytät niitä tarkoituksella. Ilman sitä edistyneitä suodattimia sovelletaan ja metatietoihin lisätään varoitus. Anna vähintään yksi rakenteellinen valitsin.

Parametrit:

repository Valinnainen
Tyyppi
str
Kuvaus
Repository muodossa owner/repo[:branch]. Valinnainen — jätä pois käyttääksesi asiakkaan pyyntökohtaista oletusta (jos annettu) tai ainoaa käytettävissä olevaa repositorya; anna erikseen vain valitaksesi toisen indeksoidun repon. Tarkasti indeksoituja haaroja suositaan; jos haara ei ole käytettävissä, se voi palautua haaraan main tai ainoaan käytettävissä olevaan haaraan. Vastauksen metatiedot näyttävät pyydetyn ja tosiasiassa käytetyn identiteetin ja varoittavat tällaisesta palautumisesta.
preset Valinnainen
Tyyppi
Literal[functions, classes, methods, imports, variables]
Kuvaus
Ensisijainen rakenteellinen valitsin. Laajenee kieliriippumattomiin AST-solmutyyppeihin — functions (funktio-/arrow-/metodimäärittelyt eri kielissä); classes (class-/struct-/interface-määrittelyt, tyyppirungot ja toteutukset); methods (metodimäärittelyt, sekä function_definition kielille, joissa ei ole metodisolmua); imports (import-/use-/include-lauseet); variables (variable-/let-/const-/static-julistukset). Suositellaan vapaan pattern/node_type-yhdistelmän sijaan selailutyyppisiin kyselyihin.
pattern Valinnainen
Tyyppi
str
Kuvaus
Vapaamuotoinen pattern täydentää puuttuvat selectorit (automaattinen tunnistus: 'def foo(' → node_type + name_pattern). Voidaan yhdistää preset-arvoon; eksplisiittiset selectorit ovat etusijalla. Suosi preset=-arvoa selauskyselyissä.
name_pattern Valinnainen
Tyyppi
str maxLength=256
Kuvaus
Symbolinimimalli (shell-jokerimerkki, rajattu POSIX-regex tai fuzzy-teksti; enintään 256 merkkiä)
node_type Valinnainen
Tyyppi
str
Kuvaus
AST-solmutyyppi (function_definition, class_definition jne.) — suosi preset= yleisiin muotoihin
decorator Valinnainen
Tyyppi
str
Kuvaus
Dekoraattorin nimen suodatin
base_class Valinnainen
Tyyppi
str
Kuvaus
Perusluokan suodatin
language_filter Valinnainen
Tyyppi
str
Kuvaus
Kielisuodatin (python, typescript jne.)
limit Valinnainen
Tyyppi
int minimum=1, maximum=50
Oletus
20
Kuvaus
Enimmäistulosmäärä sivua kohden ilman cursoria. Jatkaminen käyttää cursoriin tallennettua sivukokoa; jätä cursor pois, jos haluat aloittaa eri limit-arvolla.
offset Valinnainen
Tyyppi
int minimum=0
Kuvaus
Vanhentunut yhteensopivuus-offset. Suosi cursoria kohteesta pagination.next_cursor.
cursor Valinnainen
Tyyppi
str
Kuvaus
Läpinäkymätön cursor kohteesta pagination.next_cursor. Välitä se muuttumattomana ja pidä query ja suodattimet muuttumattomina. Sen sijainti ja sivukoko ohittavat offset- ja limit-arvot.
path_filter Valinnainen
Tyyppi
str
Kuvaus
Suodata tiedostopolun etuliitteen mukaan
branch Valinnainen
Tyyppi
str
Kuvaus
Haaran ohitus
query_type Valinnainen
Tyyppi
Literal[node_type, name_pattern, parent_child]
Kuvaus
Erikseen määritetty kyselytyyppi
parent_type Valinnainen
Tyyppi
str
Kuvaus
Ylätason AST-solmutyyppisuodatin
relationship Valinnainen
Tyyppi
Literal[parent, ancestor]
Oletus
parent
Kuvaus
parent_child-kyselyissä: vain suora parent tai mikä tahansa ancestor (käytä ancestoria luokan bodyn/lohkon alle sisäkkäin määritellyille luokkametodeille)
has_modifier Valinnainen
Tyyppi
str
Kuvaus
Suodata määreen mukaan (export, async, static jne.)
advanced Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Aseta true, kun käytät tarkoituksella edistyneitä polku-/ltree-/kutsusuodattimia (ltree_ancestor, ltree_descendant, min_depth, max_depth, field_role, definition_name, callee_text, callee_name). Arvolla false annettuja edistyneitä suodattimia sovelletaan ja metatietoihin lisätään varoitus. Suosi asetusta preset= tavallisissa rakenteellisissa kyselyissä.
callee_text Valinnainen
Tyyppi
str
Kuvaus
Edistynyt — suosi preset=functions|classes|methods|imports|variables. Kutsulausekkeen callee-tekstin suodatin. Aseta advanced=true, kun käytät tarkoituksella path-/ltree-/call-suodattimia.
callee_name Valinnainen
Tyyppi
str
Kuvaus
Edistynyt — suosi preset=functions|classes|methods|imports|variables. Kutsulausekkeen callee-nimen suodatin. Aseta advanced=true, kun käytät tarkoituksella path-/ltree-/call-suodattimia.
field_role Valinnainen
Tyyppi
str
Kuvaus
Edistynyt — suosi preset=functions|classes|methods|imports|variables. AST-kenttäroolin suodatin. Aseta advanced=true, kun käytät tarkoituksella path-/ltree-/call-suodattimia.
ltree_ancestor Valinnainen
Tyyppi
str
Kuvaus
Edistynyt — suosi preset=functions|classes|methods|imports|variables. AST-ltree-esipolven polun suodatin. Aseta advanced=true, kun käytät tarkoituksella path-/ltree-/call-suodattimia.
ltree_descendant Valinnainen
Tyyppi
str
Kuvaus
Edistynyt — suosi preset=functions|classes|methods|imports|variables. AST-ltree-jälkeläispolun suodatin. Aseta advanced=true, kun käytät tarkoituksella path-/ltree-/call-suodattimia.
definition_name Valinnainen
Tyyppi
str
Kuvaus
Edistynyt — suosi preset=functions|classes|methods|imports|variables. Määrittelynimen suodatin. Aseta advanced=true, kun käytät tarkoituksella path-/ltree-/call-suodattimia.
min_depth Valinnainen
Tyyppi
int
Kuvaus
Edistynyt — suosi preset=functions|classes|methods|imports|variables. Vähimmäis-AST-syvyys. Aseta advanced=true, kun käytät tarkoituksella path-/ltree-/call-suodattimia.
max_depth Valinnainen
Tyyppi
int
Kuvaus
Edistynyt — suosi preset=functions|classes|methods|imports|variables. Enimmäis-AST-syvyys. Aseta advanced=true, kun käytät tarkoituksella path-/ltree-/call-suodattimia.

Parhaiten sopii:

  • Rakenne AST-tasolla: classes, decorators, function-/method-presetit
  • Koodin löytäminen muodon, ei tekstin, perusteella

Ei suositella:

  • Vapaa teksti tai käsitteelliset kyselyt — käytä semantic_search- tai intelligent_search-työkalua

dependency_search Vakaa

Ensisijainen työkalu vaikutusalueen ja graafin tarkasteluun. Vastaa kysymyksiin ”mikä kutsuu tätä?” ja ”mitä tämä käyttää?” todellisen kutsu-/tuontigraafin avulla. Vaikutus ennen muokkausta: analysis_type="dependents" tai analysis_type="impact" (saapuva suunta, impact käyttää oletuksena pientä syvyyttä), oletuksena include_metrics=false (ota käyttöön keskeisyydelle ja refactor_risk-mittarille). dependents/impact sisältävät oletuksena production_callers: yksilölliset käyttökohdat tuotantokoodissa lajeittain (call, instantiate, value_reference arvoina välitetyille funktioille) sekä IMPORT-kohdat, ilman testejä ja luottamusluokalla EXTRACTED/INFERRED — ei pelkkä mittariluettelo. PR/diff-vaikutus: anna changed_paths ja/tai patch (unified diff); tunnistaa symbolit poluittain ja palauttaa tiiviit tiedot saapuvista riippuvaisista komponenteista pienellä syvyydellä ilman symbolinimen vaatimusta. Aseta muokkauksen jälkeen verify_after_edit=true ja anna targets ja/tai changed_paths saadaksesi tiiviin uuden kyselyn useasta juuresta vaikutuksen alaisille symboleille. Tukee myös arvoja dependencies, centrality ja orphans. analyze_dependencies käyttää samaa läpikäyntiä usean askeleen vaikutusanalyysiin.

Parametrit:

repository Valinnainen
Tyyppi
str
Kuvaus
Repository muodossa owner/repo[:branch]. Valinnainen — jätä pois käyttääksesi asiakkaan pyyntökohtaista oletusta (jos annettu) tai ainoaa käytettävissä olevaa repositorya; anna erikseen vain valitaksesi toisen indeksoidun repon. Tarkasti indeksoituja haaroja suositaan; jos haara ei ole käytettävissä, se voi palautua haaraan main tai ainoaan käytettävissä olevaan haaraan. Vastauksen metatiedot näyttävät pyydetyn ja tosiasiassa käytetyn identiteetin ja varoittavat tällaisesta palautumisesta.
query Valinnainen
Tyyppi
str
Kuvaus
Symbolin nimi tai hakutermi
target Valinnainen
Tyyppi
str
Kuvaus
Symbolin nimi (alias kyselylle)
symbol_id Valinnainen
Tyyppi
UUID
Kuvaus
Valitse UUID:n avulla tietty esiintymä query/target-kentässä annetun nimen ehdokkaista nimiavaruuden, polun ja kielen mukaisen suodatuksen jälkeen. Käytä find_symbol-työkalun tai graafin vaihtoehtoisten tulosten palauttamaa ID:tä. Vain nimellä määritettyyn läpikäyntiin; rajatun ehdokasikkunan ulkopuolinen ID aiheuttaa virheen.
changed_paths Valinnainen
Tyyppi
list[str] maxItems=50
Kuvaus
Tarkat repositorion juureen suhteutetut tiedostopolut PR/diff-vaikutukselle (oletus) tai, kun verify_after_edit=true, muokkauksen jälkeisen tarkistuksen juuriksi. Polut, joita ei voida ratkaista, voivat palauttaa merkittyjä ehdotuksia; ehdotetut tiedostot eivät koskaan muutu vaikutuksen lähtöpisteiksi. PR/diff: ilman rivitietoja käy läpi kunkin polun ylimmän tason määrittelyt (viedyt ensin, tiedoston järjestyksessä) ja raportoi changed_lines_unknown; anna patch=, jos tarvitset rivitasolla muuttuneet symbolit. Tarkistus: enintään 5 ylimmän tason määrittelyä polkua kohti tarkistusjuuriksi (tarkistustilassa raja on alempi). PR/diff-vaikutus ei vaadi query/target-parametria.
patch Valinnainen
Tyyppi
str maxLength=500000
Kuvaus
PR/diff-vaikutus: unified diff / git patch -teksti. Polut otetaan diff --git / --- / +++ -otsakkeista; muutoslohkojen rivit (vanha puoli = indeksoitu commit) kohdistetaan niitä ympäröiviin funktioihin, metodeihin ja luokkiin, joista edetään tarkkoihin riippuvaisiin, public_api_changed-tietoon ja kutsujiin, joihin diff ei koske.
head_commit Valinnainen
Tyyppi
str pattern=^[0-9a-fA-F]{7,64}$
Kuvaus
Kysymyksesi kohteena olevan koodin commit-SHA (git rev-parse HEAD tai patchin perus-commit). complete:true edellyttää, että indeksi on tässä commitissa ja nykyisen resolverin rakentama; muuten tulos jää arvoon complete:false ja mukana on index_stale / index_freshness_unverified / index_built_by_older_resolver, ja index_basis.statement kertoo, missä rajoissa vastaus on täydellinen. Arvon antaa myös patchin rivi 'base-commit:' (git format-patch --base).
analysis_type Valinnainen
Tyyppi
Literal[centrality, dependencies, dependents, impact, orphans]
Oletus
dependencies
Kuvaus
Analyysitila. impact = vaikutusalue (saapuvat dependents; shallow-syvyys, kun depth on jätetty pois). dependents vastaa myös impact-kyselyyn. Kun changed_paths tai patch on asetettu, analyysi pakotetaan PR-/diff-vaikutukseksi. centrality/orphans eivät vaadi targetia. orphans ovat käyttämättömän koodin ehdokkaita, eivät todiste siitä, että sen voi turvallisesti poistaa; tarkista viittaukset lähdekoodista.
depth Valinnainen
Tyyppi
Literal[shallow, balanced, deep]
Kuvaus
Kulun syvyys. Oletus on balanced; impact ja PR/diff impact käyttävät oletuksena shallow-arvoa. Eksplisiittisesti asetettu depth ohittaa nämä oletukset. Vahvistustila käyttää aina shallow-arvoa.
limit Valinnainen
Tyyppi
int minimum=1, maximum=50
Oletus
20
Kuvaus
Enimmäistulosmäärä sivua kohden ilman cursoria. Jatkaminen käyttää cursoriin tallennettua sivukokoa; jätä cursor pois, jos haluat aloittaa eri limit-arvolla.
offset Valinnainen
Tyyppi
int minimum=0
Kuvaus
Vanhentunut yhteensopivuus-offset. Suosi cursoria kohteesta pagination.next_cursor.
cursor Valinnainen
Tyyppi
str
Kuvaus
Läpinäkymätön cursor kohteesta pagination.next_cursor. Välitä se muuttumattomana ja pidä query ja suodattimet muuttumattomina. Sen sijainti ja sivukoko ohittavat offset- ja limit-arvot.
path_filter Valinnainen
Tyyppi
str
Kuvaus
Rajoittaa kohdesymbolin ratkaisun tiedostopolun etuliitteeseen; palautetut graafisuhteet voivat ulottua kyseisen polun ulkopuolelle
language_filter Valinnainen
Tyyppi
str
Kuvaus
Suodattaa kohteen ratkaisun ja selailutulokset kielen mukaan
direction Valinnainen
Tyyppi
Literal[outgoing, incoming, both]
Kuvaus
Kulkusuunta (ohittaa analysis_type-päätelmän)
relationship_types Valinnainen
Tyyppi
list[str]
Kuvaus
Suodattaa reunatyypit (CALL, IMPORT, INHERITS_FROM jne.). Ei-tyhjä lista ohittaa graph_view-oletusarvot.
exclude_test_paths Valinnainen
Tyyppi
bool
Oletus
true
Kuvaus
Oletuksena true: sulkee testi-, fixture-, vendor- ja esimerkkipolut pois läpikäynti- ja keskeisyystuloksista. Aseta false sisällyttääksesi ne. Orphan-analyysi noudattaa tätä vain, jos käyttöön otettu taustajärjestelmä tukee sitä; muuten se pitää omat tiukemmat kohinasuodatuksensa ja raportoi muutoksesta.
exclude_generated_paths Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Sulje pois generoidut deklaratiot sekä build-, kattavuus-, välimuisti-, lähdekartta- ja minifioitujen artefaktien polut läpikulkutuloksista
include_module_symbols Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Oletuksena false: jätä pois kaaret, joiden from_name tai to_name on synteettinen __module__-symboli (moduulitason kohina). Aseta true sisällyttääksesi moduulitason kaaret dependents/dependencies-tuloksiin.
include_isolated Valinnainen
Tyyppi
bool
Kuvaus
Vain orphan-analyysille. Oletuksena false. Aseta true palauttaaksesi myös symbolit, joilla ei ole riviä graafimetriikoissa (ei yhtään graafin kaarta missään). Niin kauan kuin exclude_test_paths on true, tyylitiedosto-, merkintä- ja datasymbolit (CSS, HTML, ...), .d.ts-esittelyt sekä test/fixture/vendor/example-polut pysyvät poissuljettuina, jos taustajärjestelmä tukee sitä, ellei language_filter nimeä kyseistä kieltä; TypeScript-olioliteraalien ominaisuudet voivat silti näkyä eristettyinä funktioina.
exclude_exported Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Vain orvoille symboleille. Oletus false: viedyt symbolit (julkinen API), joita ei käytetä tietovarastossa, palautetaan arvolla is_exported=true. Aseta true, jos haluat vain sisäiset ehdokkaat.
branch Valinnainen
Tyyppi
str
Kuvaus
Haaran ohitus
per_hop_limit Valinnainen
Tyyppi
int minimum=1, maximum=300
Kuvaus
Suhteiden enimmäismäärä per hyppy (1-300)
include_metrics Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Valinnaiset graafimittarit tulosriveillä (tiivistetty refactor_risk-tiedon kanssa). Mittarit haetaan myös sisäisesti, kun min_centrality>0, mutta palautetaan vain, kun tämä on true.
metrics_detail Valinnainen
Tyyppi
Literal[summary, full]
Oletus
summary
Kuvaus
Kun include_metrics=true: summary (oletus) palauttaa päätössignaalit + refactor_risk; full palauttaa suuremman kuratoidun mittarijoukon
include_edge_metadata Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Sisällytä raakareunan metatiedot ja painot (suuri). Pienikokoiset hyötykuormat jättävät tämän pois.
symbol_types Valinnainen
Tyyppi
list[str]
Kuvaus
Suodattaa palautetut symbolit tyypin mukaan (function, class, method jne.). Ei tuettu orphan-analyysissä; käytä siellä sen sijaan path_filter- tai language_filter-parametria. Tyhjä lista ei käytä tyyppisuodatusta.
exact_match Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Vaadi tarkka symbolin nimen vastaavuus
find_similar_patterns Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Etsi samanlaisia ​​​​käyttömalleja
min_centrality Valinnainen
Tyyppi
float minimum=0
Oletus
0
Kuvaus
Pienin PageRank-pistemäärä nimettyjen symbolien läpikäyntiin ja PR-/diff-vaikutusanalyysiin. Positiivisia kynnysarvoja ei tueta selaustiloissa centrality/orphans. Mittarit haetaan sisäisesti suodatusta varten; graph_metrics palautetaan vain, kun include_metrics=true. verify_after_edit ohittaa tämän, koska se käyttää kiinteitä tiiviitä asetuksia.
graph_view Valinnainen
Tyyppi
Literal[dependency, type, data_flow, control_flow]
Oletus
dependency
Kuvaus
Graafinäkymä, jota käytetään läpikäyntisuhteiden oletusarvoihin, mittareihin ja keskeisyysjärjestykseen; orphan-analyysi lasketaan kaikkien näkymien yli
verify_after_edit Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Kysyy indeksoidun impact-graafin uudelleen muokatuille symboleille yhdessä kompaktissa monijuurisessa vastauksessa. Vaatii targets- ja/tai changed_paths-parametrin (tai target/query). Käyttää kiinteää shallow-kulkua ja kompakteja budjetteja; depth-, limit-, cursor- ja metrics-hallinnat eivät päde. Palauttaa oletuksena incoming dependents -arvon; tulokset heijastavat indeksoitua graafia (voi jäädä jälkeen live-muokkauksista). Kun true, tällä on etusija PR/diff impact -arvoon nähden samoilla changed_paths-arvoilla.
targets Valinnainen
Tyyppi
list[str] maxItems=15
Kuvaus
Kun verify_after_edit=true: uudelleen tarkistettavien symbolien nimet (kutsujat/riippuvaiset komponentit). Yhdistetään target/query-parametriin, jos molemmat annetaan.

Parhaiten sopii:

  • Vaikutusalue-/vaikutusanalyysi ennen jaetun symbolin muokkaamista
  • PR-/diff-vaikutus changed_paths- tai patch-parametrin kautta
  • Muokkauksen jälkeinen tarkistus verify_after_edit-parametrilla

Ei suositella:

  • Yksinkertaiset teksti- tai symbolihaut — käytä text_pattern_search- tai find_symbol-työkalua

Koodianalyysityökalut

#

find_symbol Vakaa

Siirry kohtaan, jossa funktio, luokka tai muuttuja määritellään ja sitä käytetään. Käytä, kun tiedät nimen (esim. "getCurrentUser") — tämä on Grepiä nopeampi ja tarkempi ja kattaa koko indeksoidun repon. Palauttaa valinnaisesti viittaukset ja tärkeysmittarit.

Parametrit:

symbol_name Valinnainen
Tyyppi
str
Kuvaus
Haettavan symbolin nimi (valinnainen — jätä pois, jos haluat selata mittareiden mukaan)
repository Valinnainen
Tyyppi
str
Kuvaus
Repository muodossa owner/repo[:branch]. Valinnainen — jätä pois käyttääksesi asiakkaan pyyntökohtaista oletusta (jos annettu) tai ainoaa käytettävissä olevaa repositorya; anna erikseen vain valitaksesi toisen indeksoidun repon. Tarkasti indeksoituja haaroja suositaan; jos haara ei ole käytettävissä, se voi palautua haaraan main tai ainoaan käytettävissä olevaan haaraan. Vastauksen metatiedot näyttävät pyydetyn ja tosiasiassa käytetyn identiteetin ja varoittavat tällaisesta palautumisesta.
scope Valinnainen
Tyyppi
Literal[definitions, references, both]
Oletus
both
Kuvaus
Haun laajuus; references vaatii ei-tyhjän symbol_name-arvon.
limit Valinnainen
Tyyppi
int minimum=1, maximum=50
Oletus
15
Kuvaus
Enimmäistulosmäärä sivua kohden ilman cursoria. Jatkaminen käyttää cursoriin tallennettua sivukokoa; jätä cursor pois, jos haluat aloittaa eri limit-arvolla.
offset Valinnainen
Tyyppi
int minimum=0
Kuvaus
Vanhentunut yhteensopivuus-offset. Suosi cursoria kohteesta pagination.next_cursor.
cursor Valinnainen
Tyyppi
str
Kuvaus
Läpinäkymätön cursor kohteesta pagination.next_cursor. Välitä se muuttumattomana ja pidä query ja suodattimet muuttumattomina. Sen sijainti ja sivukoko ohittavat offset- ja limit-arvot.
find_similar Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Sisällytä samanlaiset symbolien nimet
include_metrics Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Sisällytä keskeisyysmittarit
metrics_detail Valinnainen
Tyyppi
Literal[summary, full]
Oletus
summary
Kuvaus
Kun include_metrics=true: summary (oletus) palauttaa päätössignaalit + refactor_risk; full palauttaa suuremman kuratoidun mittarijoukon
path_filter Valinnainen
Tyyppi
str
Kuvaus
Suodata tiedostopolun etuliitteen mukaan
branch Valinnainen
Tyyppi
str
Kuvaus
Haaran ohitus
symbol_type Valinnainen
Tyyppi
str minLength=1
Kuvaus
Suodata indeksoidun symbolityypin mukaan, esim. function, class, struct, enum tai trait. Käytä symbolituloksen palauttamaa tyyppiä; tyyppi vaihtelee kielen mukaan.
high_impact Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Selaa arkkitehtonisesti tärkeitä symboleita (jätä symbol_name pois). Oletustila on popularity (ylin PageRank-desiili miinus utility-megasolmukohdat). Aseta high_impact_mode=risk artikulaatio-/silta-leikkauspisteitä varten.
high_impact_mode Valinnainen
Tyyppi
Literal[popularity, risk]
Oletus
popularity
Kuvaus
Kun high_impact=true: popularity = ylin PageRank-desiili ilman apuohjelmien megasolmukohtia/moduuleja; risk = artikulaatiopisteet järjestettyinä ensin SMV bridge_count- ja sitten k_core-arvon mukaan (rakenteellinen refaktorointiriski, ei solmukohdan suosio)
in_cycle Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Suodattaa symbolit, joiden riippuvuussyklijäsenyys on kirjattu.
exclude_test_paths Valinnainen
Tyyppi
bool
Oletus
true
Kuvaus
Kun selaat graafimittareita, sulje pois testit, testiaineistot, kolmannen osapuolen koodi ja esimerkit ennen tulosten järjestämistä. Nimetyn symbolin haku ei muutu.
reference_views Valinnainen
Tyyppi
list[Literal[dependency, type, data_flow, control_flow, all]] minItems=1, maxItems=5
Kuvaus
Graafin näkymät, joiden saapuvat kaaret täyttävät references/reference_count-kentät (scope references/both). Oletus ["dependency", "type"]: kutsut, tuonnit, viennit, viittaukset, ilmentymien luonti, periytyminen, korvaukset, dekoraattorit ja tyyppien käyttö. Ellei data_flow ole valittuna, tarkasti ratkaistut data_flow-käytöt (takaisinkutsut, käsittelijät, lajitteluavaimet) palautetaan erikseen kentissä value_references/value_reference_count ilman pelkän nimen perusteella pääteltyjä osumia. Lisää data_flow tai control_flow tai anna ["all"] kaikille kaarityypeille ja tasoille. Samat näkymäperheet kuin dependency_search-työkalun graph_view.
relationship_types Valinnainen
Tyyppi
list[str]
Kuvaus
Eksplisiittiset viittauskaarien tyypit (CALL, IMPORT, READS jne.). Lista, joka ei ole tyhjä, ohittaa reference_views-arvon.

Parhaiten sopii:

  • Tunnetun symbolin määrittelyn, viittausten ja graafimittareiden kiinnittäminen
  • Selaaminen centrality-, high_impact- tai in_cycle-parametrin mukaan, kun symbol_name jätetään pois

Ei suositella:

  • Käsitteelliset kyselyt tai tuntemattoman alueen kyselyt — käytä intelligent_search- tai semantic_search-työkalua

analyze_dependencies Vakaa

Analysoi vaikutusalue samalla läpikäynnillä kuin dependency_search (dependents/incoming). Suosi vaikutusanalyysissä työkalua dependency_search asetuksella analysis_type="dependents" tai "impact". Palauttaa usean askeleen vaikutusvastauksen, jossa ovat graph, connection_summary ja valinnaiset mittarit refactor_risk mukaan lukien. connection_summary laskee valitulle juurelle suhdeperheeseen rajatut kaaret ennen testi- tai polkusuodatusta. Vanhat kentät incoming_production/outgoing_production tarkoittavat moduulien ulkopuolisia kaaria, testit mukaan lukien; ne eivät ole tuotantokutsujien määriä. Rajaa suhteiden perhe parametrilla graph_view: dependency (oletus), type, data_flow, control_flow.

Parametrit:

repository Valinnainen
Tyyppi
str
Kuvaus
Repository muodossa owner/repo[:branch]. Valinnainen — jätä pois käyttääksesi asiakkaan pyyntökohtaista oletusta (jos annettu) tai ainoaa käytettävissä olevaa repositorya; anna erikseen vain valitaksesi toisen indeksoidun repon. Tarkasti indeksoituja haaroja suositaan; jos haara ei ole käytettävissä, se voi palautua haaraan main tai ainoaan käytettävissä olevaan haaraan. Vastauksen metatiedot näyttävät pyydetyn ja tosiasiassa käytetyn identiteetin ja varoittavat tällaisesta palautumisesta.
target Pakollinen
Tyyppi
str minLength=1
Kuvaus
Analysoitava symbolin nimi
symbol_id Valinnainen
Tyyppi
UUID
Kuvaus
Valitse UUID:n avulla tietty esiintymä target-ehdokkaista nimiavaruuden, polun ja kielen mukaisen suodatuksen jälkeen; rajatun ehdokasikkunan ulkopuoliset ID:t aiheuttavat virheen.
depth Valinnainen
Tyyppi
Literal[shallow, balanced, deep]
Oletus
balanced
Kuvaus
Analyysin syvyys
limit Valinnainen
Tyyppi
int minimum=1, maximum=50
Oletus
10
Kuvaus
Enimmäistulosmäärä sivua kohden ilman cursoria. Jatkaminen käyttää cursoriin tallennettua sivukokoa; jätä cursor pois, jos haluat aloittaa eri limit-arvolla.
offset Valinnainen
Tyyppi
int minimum=0
Kuvaus
Vanhentunut yhteensopivuus-offset. Suosi cursoria kohteesta pagination.next_cursor.
cursor Valinnainen
Tyyppi
str
Kuvaus
Läpinäkymätön cursor kohteesta pagination.next_cursor. Välitä se muuttumattomana ja pidä query ja suodattimet muuttumattomina. Sen sijainti ja sivukoko ohittavat offset- ja limit-arvot.
direction Valinnainen
Tyyppi
Literal[incoming, outgoing, both]
Oletus
incoming
Kuvaus
Kulkusuunta
relationship_types Valinnainen
Tyyppi
list[str]
Kuvaus
Suodattaa reunatyypit (CALL, IMPORT, INHERITS_FROM jne.). Ei-tyhjä lista ohittaa graph_view-oletukset; tyhjä lista käyttää näitä oletuksia.
graph_view Valinnainen
Tyyppi
Literal[dependency, type, data_flow, control_flow]
Oletus
dependency
Kuvaus
Graafinäkymä: määrittää sekä oletuksena kuljettavat reunatyypit että sen, minkä näkymän metriikkaa käytetään, kun include_metrics=true. dependency=[CALL,IMPORT,EXPORTS,REFERENCE,INSTANTIATES] (oletus), type=[INHERITS_FROM,IMPLEMENTS,OVERRIDE,DECORATES,OF_TYPE], data_flow=[READS,WRITES,ASSIGNS_TO], control_flow=[CONTROL_FLOW,THROWS,CATCHES]. Sitä käytetään relationship_types-arvon oletuksena, kun relationship_types jätetään pois tai on tyhjä. Vastaa dependency_search-työkalun jo olemassa olevaa graph_view-parametrin nimeä työkalujen välisen johdonmukaisuuden vuoksi.
path_filter Valinnainen
Tyyppi
str
Kuvaus
Rajoittaa kohdesymbolin ratkaisun tiedostopolun etuliitteeseen; palautetut graafisuhteet voivat ulottua kyseisen polun ulkopuolelle
language_filter Valinnainen
Tyyppi
str
Kuvaus
Kielisuodatin
branch Valinnainen
Tyyppi
str
Kuvaus
Haaran ohitus
per_hop_limit Valinnainen
Tyyppi
int minimum=1, maximum=300
Kuvaus
Suhteiden enimmäismäärä per hyppy (1-300)
include_metrics Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Sisällytä tuloksiin graafimittarit, joista jokainen on rikastettu johdetulla refactor_risk-lohkolla ({risk: "low"|"medium"|"high", is_articulation_point, bridge_count, k_core, graph_view, reasons}). risk on "low", kun symboli ei ole valitussa näkymässä articulation point, "medium", kun articulation point yhdistää muutamia reunoja, ja "high", kun se yhdistää monia (heuristinen kynnys, ei empiirisesti validoitu). Lohko jätetään symbolikohtaisesti pois, kun symbolille ja näkymälle ei ole mittaririviä.
metrics_detail Valinnainen
Tyyppi
Literal[summary, full]
Oletus
summary
Kuvaus
Kun include_metrics=true: summary (oletus) palauttaa päätössignaalit + refactor_risk; full palauttaa suuremman kuratoidun mittarijoukon
include_edge_metadata Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Sisällytä raakareunan metatiedot ja painot. Oletusarvoisesti poissa käytöstä, koska poimijan metatiedot voivat olla suuria. rikastuksen kattavuus raportoidaan, kun se on käytössä.
exclude_test_paths Valinnainen
Tyyppi
bool
Oletus
true
Kuvaus
Oletuksena true: sulje testi-, fixture-, vendor- ja esimerkkipolut pois palautetuista graafin kaarista. Aseta false sisällyttääksesi ne.
include_module_symbols Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Oletuksena false sulkee pois kuvaajan reunat, kun from_name tai to_name on synteettinen __module__-symboli. Aseta true sisällyttämään moduulitason reunat.
head_commit Valinnainen
Tyyppi
str pattern=^[0-9a-fA-F]{7,64}$
Kuvaus
Kysymyksesi kohteena olevan koodin commit-SHA (git rev-parse HEAD tai patchin perus-commit). complete:true edellyttää, että indeksi on tässä commitissa ja nykyisen resolverin rakentama; muuten tulos jää arvoon complete:false ja mukana on index_stale / index_freshness_unverified / index_built_by_older_resolver, ja index_basis.statement kertoo, missä rajoissa vastaus on täydellinen. Arvon antaa myös patchin rivi 'base-commit:' (git format-patch --base).

Parhaiten sopii:

  • Usean askeleen vaikutusanalyysi, kun tarvitset vastauksen kentät graph ja connection_summary

Ei suositella:

  • Yleinen vaikutusanalyysi: suosi työkalua dependency_search joustavaan läpikäyntiin ja usean juuren tarkistuksiin

get_task_context Vakaa

Aloitatko työskentelyn tuntemattomalla alueella? Kuvaa tehtävä (esim. "lisää SSO-tuki", "korjaa laskutus-webhook") ja saat yhdellä kutsulla rajatun paketin asiaankuuluvia tiedostoja, koodia, symboleita ja riippuvuuksia. Lähtöpisteinä annetut tiedostot tuovat suoraan indeksoitua sisältöä, vaikka ne eivät määrittelisi yhtään symbolia. Epäonnistuneet kerrokset merkitään; täydellinen hakuepäonnistuminen palauttaa työkaluvirheen. Saadaksesi lisää tuloksia, jatka kyseisen kerroksen erikoistuneella hakutyökalulla.

Parametrit:

task_description Pakollinen
Tyyppi
str minLength=1
Kuvaus
Kuvaus tehtävästä, johon tarvitset kontekstin
repository Valinnainen
Tyyppi
str
Kuvaus
Repository muodossa owner/repo[:branch]. Valinnainen — jätä pois käyttääksesi asiakkaan pyyntökohtaista oletusta (jos annettu) tai ainoaa käytettävissä olevaa repositorya; anna erikseen vain valitaksesi toisen indeksoidun repon. Tarkasti indeksoituja haaroja suositaan; jos haara ei ole käytettävissä, se voi palautua haaraan main tai ainoaan käytettävissä olevaan haaraan. Vastauksen metatiedot näyttävät pyydetyn ja tosiasiassa käytetyn identiteetin ja varoittavat tällaisesta palautumisesta.
limit Valinnainen
Tyyppi
int minimum=1, maximum=50
Oletus
15
Kuvaus
Tulosten enimmäismäärä kerrosta kohden
scope Valinnainen
Tyyppi
Literal[semantic, symbols, dependencies, all]
Oletus
all
Kuvaus
Mitkä kontekstitasot sisällytetään
language_filter Valinnainen
Tyyppi
str
Kuvaus
Kielisuodatin: edellyttää scope=semantic ilman nimenomaisia lähtöpisteitä tai liittyvää kontekstia; muiden kerrosten indeksit eivät voi pakottaa kielirajausta.
path_filter Valinnainen
Tyyppi
str
Kuvaus
Tiedostopolun etuliite semanttisen ja avainsanahaun lähtöpisteille. Eksplisiittiset seedit voivat sijaita tämän etuliitteen ulkopuolella; graafikonteksti voi ylittää hakemistorajoja.
branch Valinnainen
Tyyppi
str
Kuvaus
Haaran ohitus
include_related_context Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Sisällytä asiaan liittyvä konteksti viereisistä symboleista
seed_symbol_ids Valinnainen
Tyyppi
list[str] maxItems=20
Kuvaus
Eksplisiittiset tehtävän seedit: näkyvät ensimmäisenä symbolikerroksessa ja säilyvät rajatussa dependencies/related_context-ikkunassa. Graafikerrokset asettavat eksplisiittiset seedit ja niiden lähimmän naapuruston järjestykseen ennen avainsanoihin palaamista; tärkeys ratkaisee vain osumien ollessa yhtä osuvia. Graafin laajentaminen edellyttää scope=all|dependencies (scope=symbols|semantic ei koskaan suorita riippuvuuksien läpikäyntiä). Jätä pois, jos haluat järjestyksen pelkkien avainsanojen ja syvyyden mukaan vähenevän tärkeyden perusteella.
seed_file_paths Valinnainen
Tyyppi
list[str] maxItems=10
Kuvaus
Eksplisiittiset lähtöpisteet: tarkat indeksoidut tiedostopolut, jotka agentti on avannut tai juuri muokannut. Palauttaa rajatun suoran tiedostotodisteen ja enintään 5 graafin lähtöpistettä tiedostoa kohden; rajatusta symbolihausta saadut tarkat osumat tehtävän nimeen menevät määrittelyjen ja satunnaisten symbolien edelle. Myös symbolittomat tiedostot tuottavat todisteita. Puuttuvat tiedostot voivat palauttaa merkittyjä ehdotuksia, jotka eivät ole lähtöpisteitä. Graafin laajentaminen edellyttää scope=all|dependencies.

Parhaiten sopii:

  • Tehtävätietoinen konteksti, joka yhdistää lähtöpisteinä annetut tiedostot semanttisiin, symboli- ja riippuvuuskerroksiin

Ei suositella:

  • Yhden työkalun haut, joissa tarkempi työkalu jo vastaa kysymykseen

get_file Vakaa

Lukee tiedoston indeksoidusta repositoriosta polun perusteella. Suosi paikallisia tiedostotyökaluja levyllä oleville tiedostoille; käytä tätä etäindeksoituihin tilannevedoksiin. Jatka rajoitettuja vastauksia kohteilla metadata.next_line_start ja next_character_start. Poista lopun rivinvaihto ja [truncated]-merkintä vain, kun metadata.truncated=true; muuten kyseessä voi olla kirjaimellinen lähdeteksti.

Parametrit:

file_path Pakollinen
Tyyppi
str
Kuvaus
Tiedostopolku suhteessa repositorion juureen
repository Valinnainen
Tyyppi
str
Kuvaus
Repository muodossa owner/repo[:branch]. Valinnainen — jätä pois käyttääksesi asiakkaan pyyntökohtaista oletusta (jos annettu) tai ainoaa käytettävissä olevaa repositorya; anna erikseen vain valitaksesi toisen indeksoidun repon. Tarkasti indeksoituja haaroja suositaan; jos haara ei ole käytettävissä, se voi palautua haaraan main tai ainoaan käytettävissä olevaan haaraan. Vastauksen metatiedot näyttävät pyydetyn ja tosiasiassa käytetyn identiteetin ja varoittavat tällaisesta palautumisesta.
line_start Valinnainen
Tyyppi
int minimum=1
Kuvaus
Aloitusrivi (1-indeksoitu)
line_end Valinnainen
Tyyppi
int minimum=1
Kuvaus
Loppurivi (1-indeksoitu, mukaan lukien; oltava kohdassa line_start tai sen jälkeen)
character_start Valinnainen
Tyyppi
int minimum=0
Oletus
0
Kuvaus
Siirtymä UTF-16-koodiyksikköinä vain aloitusrivillä (indeksointi alkaa nollasta). Jatka osittain luettua riviä käyttämällä metadata.next_character_start-arvoa.
branch Valinnainen
Tyyppi
str
Kuvaus
Haaran ohitus
max_tokens Valinnainen
Tyyppi
int minimum=1, maximum=50000
Oletus
5000
Kuvaus
Arvioitu sisältöbudjetti (4 UTF-16-koodiyksikköä tokenia kohti; ei tokenisaattorin tarkka raja).
include_metadata Valinnainen
Tyyppi
bool
Oletus
true
Kuvaus
Sisällytä tiedostoa kuvaavat metatiedot. Katkaisun ja jatkamisen metatiedot palautetaan aina.

Parhaiten sopii:

  • Etä- tai indeksoidut tiedostotilannevedokset (rivialueet, token-rajat)

Ei suositella:

  • Polku, joka on jo paikallisella levyllä — käytä paikallista Read-työkalua

Järjestelmä- ja apuohjelmatyökalut

#

repository_context Vakaa

Listaa repositoriot, joita voit hakea, tai hakee tunnistetiedot yhdestä repositoriosta (namespace/branch, indexed_commit_sha / indeksin tuoreus). Käytä action:"list", kun repositorion slug ei ole tiedossa; hakutyökalut hyväksyvät tunnetun slugin suoraan tai käyttävät oletuksena avaimesi ainoaa repositoriota. list käyttää pattern- ja sivutusparametreja; info vaatii repository-parametrin ja tukee branch-parametria sekä valinnaista include_statistics=true-arvoa.

Parametrit:

action Pakollinen
Tyyppi
Literal[list, info]
Kuvaus
Toiminto: "list" (listaa käytettävissä olevat repositoriot) tai "info" (näyttää repon tiedot)
repository Valinnainen
Tyyppi
str
Kuvaus
Vain info-toiminnolle: repository muodossa owner/repo tai owner/repo:branch (vaaditaan info-toiminnossa)
branch Valinnainen
Tyyppi
str
Kuvaus
Vain info-toiminnolle: haaran ohitus
pattern Valinnainen
Tyyppi
str
Kuvaus
Vain list-toiminnolle: repositorion nimen osamerkkijono, ei kirjainkoosta riippuvainen
include_statistics Valinnainen
Tyyppi
bool
Oletus
false
Kuvaus
Vain tiedoksi: sisältää rajoitettuja indeksoidun datan määriä. file/blob-määrät ovat tarkkoja; suuremmat indeksimäärät ovat arvioita. Katso count_accuracy ja estimate_analyzed_at. Oletusarvo false.
limit Valinnainen
Tyyppi
int minimum=1, maximum=50
Oletus
20
Kuvaus
Enimmäistulosmäärä sivua kohden ilman cursoria. Jatkaminen käyttää cursoriin tallennettua sivukokoa; jätä cursor pois, jos haluat aloittaa eri limit-arvolla.
offset Valinnainen
Tyyppi
int minimum=0
Kuvaus
Vanhentunut yhteensopivuussiirtymä. Valitse cursor pagination.next_cursor:stä.
cursor Valinnainen
Tyyppi
str
Kuvaus
Läpinäkymätön cursor kohteesta pagination.next_cursor. Välitä se muuttumattomana ja pidä query ja suodattimet muuttumattomina. Sen sijainti ja sivukoko ohittavat offset- ja limit-arvot.

Parhaiten sopii:

  • Käytettävissä olevien repositorioiden listaaminen
  • Repositorion identiteetin, branchin ja HEAD-vs-indeksin tuoreuden ratkaiseminen

Ei suositella:

  • Nimiavaruuden laajuiset tilastot oletuksena — anna include_statistics=true eksplisiittisesti, koska se voi olla hitaampi kuin ratkaiseminen

ask_maguyva Vakaa

Hae Maguyva-työkalujen ohjeita tai lähetä virheraportti tai ominaisuuspyyntö, joka tallennetaan Maguyva-palvelun ylläpitäjille. Älä koskaan sisällytä palautteeseen salaisuuksia tai arkaluonteisia henkilötietoja. Operaatio evaluate tukee deterministisiä lausekkeita; suosi paikallista laskentaa tai isäntäympäristön työkaluja matematiikkaan, tiivisteisiin ja merkkijonoihin.

Parametrit:

operation Pakollinen
Tyyppi
Literal[guidance, report_bug, request_feature, evaluate]
Kuvaus
Käytä arvoa guidance työkaluohjeisiin, report_bug virheisiin tai request_feature ehdotuksiin. evaluate suorittaa deterministisiä lausekkeita; suosi paikallista laskentaa laskutoimituksissa.
query Valinnainen
Tyyppi
str maxLength=500
Kuvaus
Ohjeen aihe (esimerkiksi tool_selection, semantic_search) tai lausekemerkkijono operaatiolle evaluate.
description Valinnainen
Tyyppi
str minLength=1, maxLength=4000
Kuvaus
Vaaditaan report_bug- ja request_feature-toiminnoille. Vapaamuotoinen palaute Maguyva-ylläpitäjille. Älä koskaan sisällytä salaisuuksia tai arkaluonteisia henkilötietoja.
related_tool Valinnainen
Tyyppi
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]
Kuvaus
Valinnainen Maguyva-työkalu, joka liittyy läheisimmin palautteeseen

Parhaiten sopii:

  • Työkaluohjeet (operation="guidance")
  • Pysyvät bugiraportit ja ominaisuuspyynnöt Maguyva-ylläpitäjille

Ei suositella:

  • Matematiikka, tiivisteiden laskenta ja merkkijonot: suosi paikallista laskentaa tai isäntäympäristön työkaluja

Parhaat käytännöt

#
  1. Käytä nimenomaisia ohituksia tarkoituksella: Jätä repository pois, kun MCP-asiakas antaa pyyntökohtaisen oletuksen tai kun avaimella on pääsy täsmälleen yhteen repositoryyn; muussa tapauksessa anna se erikseen.
  2. Valitse oikea hakutila: Käytä intelligent_search mode="auto":n kanssa useimmissa tapauksissa. Määritä tila, kun tiedät tarkalleen mitä tarvitset.
  3. Hyödynnä kielisuodattimia: Käytä language_filter kaventaaksesi tuloksia ja parantaaksesi suorituskykyä.
  4. GraphRAG-tehostus: GraphRAG-tärkeystehostus on oletuksena pois päältä semanttisessa haussa (boost_by_importance=false), jotta järjestys pysyy agentille turvallisena. Anna boost_by_importance=true ottaaksesi käyttöön keskeisyystietoisen uudelleenjärjestelyn arkkitehtuurikatselmuksia varten.
  5. Repositorion täsmäytys ei ole kirjainkokoherkkä, mutta ei myöskään sumea: repository_context vertaa repositorioiden nimiä kirjainkoosta riippumatta — se ei kuitenkaan korjaa kirjoitusvirheitä. Kun palvellun kohteen identiteetti poikkeaa pyydetystä, metadata.resolution_reason ilmoittaa "defaulted" (haaraa ei pyydetty) tai "fallback" (pyydetty haara tai repositorio ei ole saatavilla). Kenttä jätetään pois, kun pyyntö osui täsmälleen.
  6. Yhdistä työkalut: Käytä useita API-menetelmiä yhdessä kattavaan analyysiin.
  7. Käsittele suuria tuloksia: Käytä parametria limit ja työkalukohtaisia sivutussäätimiä (esimerkiksi line_start/line_end työkalussa get_file).
  8. Käytä ask_maguyva-työkalua työkaluohjeisiin: Kutsu työkalua ask_maguyva asetuksilla operation="guidance" ja query="tool_selection", niin saat työkaluvalinnan ohjeita ja esimerkkejä. Käytä paikallisia työkaluja laskutoimituksiin ja merkkijonomuunnoksiin.
  9. Varmista vaikutukset ennen ja jälkeen muokkauksen: Ennen jaetun symbolin muokkaamista kutsu työkalua dependency_search asetuksella analysis_type="impact" (tai anna changed_paths PR/diff-vaikutusten tarkastelua varten), jotta näet vaikutusalueen. Aseta muutoksen jälkeen verify_after_edit=true ja anna targets ja/tai changed_paths, niin saat tiiviin uudelleentarkistuksen indeksoidusta graafista. Tämä ei lue paikallisia muutoksia, joista ei ole tehty committia, eikä korvaa paikallisia testejä. Tarkista indexed_commit_sha ja indeksin ajantasaisuus ennen kuin käytät tuloksia uuden revision todisteena.

Suorituskykyominaisuudet

#
Toiminto Suorituskykyhuomiot
Semanttinen haku Sisältää kyselyn vektoriesityksen luonnin ja vektorihaun. Viive riippuu molemmista operaatioista.
Tekstihaku Likimääräisessä sisältöhaussa myöhemmät sivut hakevat enemmän ehdokkaita. Rajaa kyselyä parametreilla path_filter ja language_filter.
Rakenteellinen haku Hakee indeksoiduista AST-solmuista. Käytä tiettyä esiasetusta tai mallia ja rajoita tulosten määrää.
Riippuvuushaku Kustannus kasvaa syvyyden mukana — suosi asetusta depth="shallow", ellet tarvitse usean askeleen graafikontekstia; per_hop_limit rajaa haarautumista
Tiedostohaku Lue tarvittava alue parametreilla line_start/line_end tai max_tokens ja käytä palautettuja jatkamisen metatietoja katkaistulle sisällölle.
Repositoriokonteksti Repositorio tunnistetaan jokaisessa työkalukutsussa. Anna repository erikseen, kun tarvitset tietyn repositorion.
ask_maguyva (guidance / evaluate) Suoritetaan MCP-palvelimella ilman kyselyä repositorion indeksiin.

Virheenkäsittely

#

Työkalujen vastauksissa on yhteiset tilakentät ja työkalukohtaiset tietokentät ylimmällä tasolla. Haut palauttavat results-kentän; get_file palauttaa content-kentän. Yhteisiä kenttiä ovat:

  • status: Merkkijono — "success" tai "error". Heikentyneen osuman ja indeksin tuoreuden signaaleilla on omat kenttänsä: metadata.resolution_reason kohdassa metadata ja index_freshness.status repository_contextin info-toiminnon ylimmällä tasolla.
  • timing_ms: Työkalun suoritukseen kulunut aika millisekunteina
  • applied_filters: Operaatiota varten kirjatut tosiasialliset pyyntöparametrit
  • error: Virheilmoitus merkkijonona, kun status on "error"; voi sisältää palautumisohjeita.
  • metadata: Lisätietoa operaatiosta (reititys, välimuistitus, parametrisäädöt)
  • pagination: Mukana kursorilla sivutettujen kokoelmien vastauksissa; sisältää kentät has_more ja next_cursor. Järjestetyt hakuikkunat ovat rajattuja top-K-tuloksia, eivät kattavia sivutettuja kokoelmia.

Tarkista status-kenttä ennen työkalun hyötykuorman käsittelyä — sen arvot ovat "success" tai "error". Käsittele myös MCP/JSON-RPC-siirtovirheet ja pyynnön validointivirheet, joita voi syntyä jo ennen kuin hyötykuormaa on olemassa. Heikentyneen osuman tai tuoreuden signaalit luetaan niille varatusta kentästä: metadata.resolution_reason kohdassa metadata tai index_freshness.status repository_contextin info-toiminnon ylimmällä tasolla (known/partial/unknown/unavailable).

Aloittaminen

#
  1. Määritä MCP-asiakas: Osoita MCP-asiakas Maguyva-palvelimen endpointiin
  2. Vahvista repositoryjen käyttöoikeus: Tarkista API-avaimen käytettävissä olevat repositoryt komennolla repository_context(action="list"/"info")
  3. Aloita haku: Aloita intelligent_search-työkalulla ja tutustu tarvittaessa erikoistyökaluihin
  4. Yhdistä työkalut: Käytä useita työkaluja yhdessä kattavaan koodianalyysiin

Yksityiskohtaiset integraatio-ohjeet löydät kohdasta asennusopas.

Aiheeseen liittyvää

Lue seuraavaksi