Przejdź do głównej zawartości
Produkty
PL

DevHub · Dokumentacja techniczna

Narzędzia DevHub dla agentów AI

To narzędzia, które DevHub udostępnia podłączonemu klientowi AI. Nazwy, opisy i parametry są pokazane tak, jak zgłasza je DevHub, po angielsku. Narzędzia są pogrupowane według przedrostka nazwy. Adres serwera MCP skopiuj z Pulpitu.

Stan DevHub 0.8.1 z dnia 2026-10-19. * oznacza parametr wymagany.

agent

agent_create

Configure an agent from a persona. Call agent_list first for the visible personas, clients, repositories and brains. Created switched off until the owner turns it on.

ParametrTypOpis
namestring | nullPersonal name; null clears it.
label *string
personaId *stringThe role. It stays live: what it names is not copied in.
connectorId *stringWhich client runs it.
modelstring
effortstring
sandboxstringDefault read-only. read-onlyworkspace-write
addSkillsarray
removeSkillsarray
addRulesarray
addCommandsarray
timeLimitSecondsinteger10-3600
brainobject
devhubToolsboolean
skillScriptsboolean
deliverystring autoinline
variantsarray | null
workspaceId *string
agent_list

The agents configured for this repository (what each does, which client runs it, whether it can run at all), then what agent_create can be given: clients with their models and reasoning levels, personas, repositories. Call before doing work another agent is set up for, and before creating one.

ParametrTypOpis
workspaceIdstringNarrow to one repository. Omit for everything this endpoint can see.
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens; overflow is cut on a record boundary and announced. Defaults to 2000 — raise it to see a longer list.
agent_run

Use for tasks assigned to an agent from agent_list. Returns an answer or RUNNING <runId> after 45 seconds. RUNNING is not failure: call agent_run_status with wait; do not retry.

ParametrTypOpis
agentId *stringFrom agent_list.
task *stringWhat it should do, in its own terms. Not a prompt: the role and the rules are already assembled.
modelstringAllowed variant; omit for default.
effortstring
allowAgentsbooleanAllow this run to start agents.
agent_run_status

Use after RUNNING; wait here, not by rerunning. RUNNING is not failure; answers last an hour.

ParametrTypOpis
runId *string
waitnumberWait seconds; default 0.
agent_update

Use to change an agent's configuration or personal name. Names and labels are cosmetic; widening capabilities switches it off for owner review. Cannot switch it on.

ParametrTypOpis
agentId *stringFrom agent_list.
namestring | nullPersonal name; null clears it.
labelstring
modelstringOne the client offers; agent_list carries the catalogue.
effortstring
sandboxstring read-onlyworkspace-write
addSkillsarray
removeSkillsarray
timeLimitSecondsinteger10-3600
brainobject
devhubToolsboolean
skillScriptsboolean
deliverystring autoinline
variantsarray | null

asset

asset_read

Read a binary file as Base64; images come back as viewable content. Use file_read for text.

ParametrTypOpis
path *string
workspaceId *string
asset_write

Write a binary file from Base64 — images, audio, PDFs, archives, up to 20 MB. Use file_write for text.

ParametrTypOpis
path *string
base64 *string
mimeTypestring
overwriteboolean
workspaceId *string

audit

audit_analyze

Repeated errors and slow tools with recommendations. Use when something fails intermittently and you need the pattern rather than one event.

ParametrTypOpis
sinceHoursinteger
toolstring
audit_list

Inspect individual MCP calls. Use when a specific tool call failed and you need its arguments, error and timing.

ParametrTypOpis
limitinteger
resultstring allsuccesserror
toolstring
categorystring
sincestring
untilstring
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens; overflow is cut on a record boundary and announced. Defaults to 2000 — raise it to see a longer list.
audit_summary

Success rate and duration totals over a window. Use to answer "is anything broken right now" before digging into individual events.

ParametrTypOpis
sinceHoursinteger
toolstring

context

context_get

The same read as context_pull, without emptying the queue: the queued vault notes, code symbols and overviews merged into one payload with its manifest. Use it when the queue is shared and whoever queued it still needs it there; use context_pull when you are the one consuming it.

ParametrTypOpis
peekbooleanReturn the manifest only, without the bodies.
idsarrayRead only these manifest ids. Omit to read everything. Use peek first to see the ids.
tokenBudgetintegerMax output tokens; overflow is cut on a block boundary and announced.
context_pull

Take the context the user queued for you in Context AI: vault notes, code symbols and repository overviews, merged into one payload with a manifest saying where every part came from. Reading it empties the queue. Call it at the start of a task, before searching on your own.

ParametrTypOpis
peekbooleanReturn the manifest only and leave the queue untouched.
idsarrayTake only these manifest ids and leave the rest queued. Omit to take everything. Use peek first to see the ids.
tokenBudgetintegerMax output tokens; overflow is cut on a block boundary and announced.

directory

directory_create

Create a repository directory. Rarely needed on its own — file_create makes missing parents.

ParametrTypOpis
path *string
workspaceId *string

display

display_list

List monitors with their IDs. Call before display_screenshot to pick one.

ParametrTypOpis
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens; overflow is cut on a record boundary and announced. Defaults to 2000 — raise it to see a longer list.
display_screenshot

Capture a monitor as PNG. Use when you need to see what the user sees — a running app, a rendered view, a visual bug.

ParametrTypOpis
displayId *string
pathstring
saveboolean
ttlSecondsinteger
workspaceIdstring

file

file_create

Create a new repository file and any missing parents, failing if it already exists. Use file_write instead when replacing an existing file is intended.

ParametrTypOpis
path *string
contentstring
workspaceId *string
file_delete

Delete a repository file or directory. Irreversible; confirm with the user first unless they asked for it.

ParametrTypOpis
path *string
recursiveboolean
workspaceId *string
file_edit

Apply several line-range edits to one repository file in one call, all or none. Take the line numbers and expectedHash from file_read; ranges refer to the file as you read it. Prefer this over file_replace when you know where the change goes.

ParametrTypOpis
path *string
expectedHash *stringThe hash from the read header. Refused if the file changed since.
edits *array
workspaceId *string
file_read

Read one repository file, whole or a line range. Pass offset and limit when a repo_* result already told you which lines to look at.

ParametrTypOpis
path *string
offsetintegerFirst line to return, 1-based. Omit for the whole file.
limitintegerHow many lines to return from offset. Omit to read to the end.
tokenBudgetintegerMax output tokens; overflow is cut on a line boundary and announced. No default — a read is never shortened unless you ask.
lineNumbersbooleanDefault true: every line is prefixed with its number and a tab, which is where the ranges for file_edit come from. Pass false for the raw bytes, e.g. to build an oldText for file_replace.
workspaceId *string
file_replace

Change known exact text in a repository file, one pair or several in one call. Use when you know the text but not the line, e.g. after files_search; for changes at known lines use file_edit.

ParametrTypOpis
path *string
oldTextstring
newTextstring
replaceAllboolean
expectedOccurrencesinteger
replacementsarraySeveral pairs in one call. Each oldText must be found in the file as you read it.
expectedHashstringOptional. From the read header; refused if the file changed since.
workspaceId *string
file_write

Create or fully overwrite a repository file. Prefer file_replace for edits — overwriting discards anything you did not include.

ParametrTypOpis
path *string
content *string
workspaceId *string

files

files_list

Browse a repository directory. Use to discover paths; use repo_symbol_search when you are looking for a definition.

ParametrTypOpis
pathstring
workspaceId *string
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens; overflow is cut on a record boundary and announced. Defaults to 2000 — raise it to see a longer list.
files_search

Grep a repository for arbitrary text. Use for strings, config values and comments; use repo_symbol_search for definitions, which is far cheaper.

ParametrTypOpis
query *string
maxResultsinteger
workspaceId *string
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens; overflow is cut on a record boundary and announced. Defaults to 2000 — raise it to see a longer list.

investigation

investigation_add

Write a document into an investigation: what is there (analysis), a way in (variant), what to do (plan), or what was settled (finding). Call when you have finished a piece of the looking, before moving to the next — two ways of doing the same thing are two documents, not one rewritten.

ParametrTypOpis
id *string
title *string
typestring analysisvariantplanfinding
body *string
statusstring draftactiveverifiedsupersededarchived
linksarrayVault notes this drew on or concluded into, as vartari://vault/<vaultId>/<path>.
investigation_close

Mark an investigation finished. Call it when a plan came out of the spike and that plan has landed: it leaves investigation_list and stays readable by id. Removal is a different decision, made later.

ParametrTypOpis
id *string
reopenbooleanPut a closed one back among the open ones.
investigation_create

Open a container for a spike: what is being looked into, and the ticket it is being done for when there is one. Documents go in it with investigation_add.

ParametrTypOpis
title *string
keystringA ticket key such as VAR-123. It names the container.
subjectstringOne sentence on what is being found out.
repositoriesarrayWorkspace ids this spike is about. Optional.
investigation_list

Spike analyses this DevHub holds: what was looked into, and what came out of it. Call before starting an investigation — the ground may already have been covered, and a variant somebody rejected is worth knowing about. Closed ones are left out: they are finished work, still readable by id.

ParametrTypOpis
qstringSubstring of the title, subject or ticket key.
includeClosedbooleanAlso list the ones closed after their plan landed.
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens; overflow is cut on a record boundary and announced. Defaults to 2000 — raise it to see a longer list.
investigation_read

One investigation in full, or one document in it. Use after investigation_list shows one that covers what you are about to look into.

ParametrTypOpis
id *stringThe ticket key, or the id investigation_list gave.
documentIdstringOmit for the whole container: every document, assembled.

knowledge

knowledge_get

Fetch one Business Context chunk in full, including the fields knowledge_search omits. Use after a search when you need the complete source; pass the same workspaceId or vaultId you searched with, or neither if the search named neither.

ParametrTypOpis
id *string
workspaceIdstring
vaultIdstring
knowledge_index_refresh

Rebuild the Business Context index. Use after editing vault notes when knowledge_search is not returning them yet.

ParametrTypOpis
vaultIdsarray
knowledge_index_status

Check whether Business Context is indexed and current before trusting a knowledge_search result.

knowledge_search

Ask the vaults a question: decisions, canon, guidelines — "why" and "what is the rule". Built from the knowledge folders only, so a miss is not absence: `vault_overview` says which folders, `vault_files_search` reads all of them. For code use repo_symbol_search. Omit both ids to search this endpoint's scope.

ParametrTypOpis
query *string
knowledgeTypestring
limitinteger
workspaceIdstring
vaultIdstring

learning

learning_note

Call when something went wrong and the reason it went wrong is worth stating for the next session. One note per lesson, not a summary of the session. Not for how the work is done here: that is memory_note.

ParametrTypOpis
kind *string correctionerror-resolutionpreferenceworkflow
lesson *stringWhat to do differently next time, as an instruction.
triggerstringWhen it applies.
evidencestringWhat happened. No file contents.

library

library_create

Writes into the user's own collection. Call library_list first. Needs id, title, groups. Skill: when + router (+reference). Rule: rule (+paths). Command: when + command. Persona: when + agent (+skills, rules, commands). Profile: when + skills/rules/commands (+profile). Instruction: when + instruction.

ParametrTypOpis
kind *string skillrulecommandpersonaprofileinstruction
id *string
title *string
whenstring
groupsarray
descriptionstring
routerstring
referencestring
rulestring
pathsarray
commandstring
agentstring
skillsarray
rulesarray
commandsarray
profilestring
instructionstring
library_edit

Change one the user owns, fields as library_create. Use that one for a new one; what ships with DevHub or comes from a repository is edited where it lives.

ParametrTypOpis
kind *string skillrulecommandpersonaprofileinstruction
id *string
titlestring
whenstring
groupsarray
descriptionstring
routerstring
referencestring
rulestring
pathsarray
commandstring
agentstring
skillsarray
rulesarray
commandsarray
profilestring
instructionstring
library_get

One of them in full, read into this session only — nothing is installed and nothing is written. Use when library_list shows one that covers what you are doing, or to find out what a rule you are working under actually says.

ParametrTypOpis
kind *string skillrulecommandpersonaprofileinstruction
id *string
library_list

What Vartari DevHub holds of one kind that this folder does not carry: skills, rules, commands, personas, profiles or instructions, one line each with the field you decide on. Call before writing one — most of what you would write exists. Omit category to see the groups.

ParametrTypOpis
kind *string skillrulecommandpersonaprofileinstruction
categorystring
qstring
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens; overflow is cut on a record boundary and announced. Defaults to 2000 — raise it to see a longer list.

memory

memory_note

Call when you learn something standing about this work — who you are working with, how they want it done, what is being built, or where something lives. Kept until somebody removes it. Not for what went wrong: that is learning_note.

ParametrTypOpis
type *stringuser: who you are working with. feedback: how they want the work done. project: what is being built and under what constraints. reference: where something outside this repository lives. userfeedbackprojectreference
statement *stringThe fact itself, as one sentence.
whenstringWhen it holds. Leave empty when it always does.
refstringWhere it was said. No file contents.

npm

npm_script_list

See which package scripts a workspace declares. Call before npm_script_run; only declared scripts can be run.

ParametrTypOpis
workspaceId *string
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens; overflow is cut on a record boundary and announced. Defaults to 2000 — raise it to see a longer list.
npm_script_run

Run one declared package script. Use to verify a change with the project's own tests, checks or build before reporting it done. Arbitrary shell commands are not available, by design.

ParametrTypOpis
script *string
timeoutMsinteger
ciboolean
workspaceId *string

pet

pet_persona

The whole persona: role, tagline, style prompt, voice values, traits, the pet's own mood lines, and whether the persona applies to agent replies or only to the pet. Call once per session and refresh only when the user says the pet or persona mode changed.

pet_say

Show the user what you are doing. Use mood working when starting tool-based work, happy on success, idle when finished. Use error only for a real blocking failure. Returns only the resulting pet status; call pet_persona for the persona to speak in.

ParametrTypOpis
message *string
moodstring idleworkinghappyerrorspeaking
durationMsintegerDuration for temporary speaking, happy or error messages. Ignored for persistent working and idle states.
pet_status

Which state the desktop pet is in right now — idle, working, happy, error or speaking — and its current message. Use to check what the user is seeing; call pet_persona for who the pet is.

plan

plan_claim

Take one step, exclusively. Answers with the step, a working tree to do it in, and its resume — so nothing else has to be asked. Refused when somebody holds it, a gate is open, or a step in progress is touching the same files, and the refusal says which.

ParametrTypOpis
planId *string
stepId *string
bystringWho is taking it. Taken from an agent endpoint automatically.
ttlMinutesinteger
plan_close

Call when a step is finished: it merges the working tree back and records what landed. Commit with a step trailer first — a step closed with nothing behind it is reported as a claim nobody can check. Closing as withdrawn merges nothing.

ParametrTypOpis
planId *string
stepId *string
bystring
commitsarrayThe commit shas this step produced.
asstringHow it ends; default done. withdrawn is for a step that will not happen: nothing is merged, the step branch is left in place so the abandoned work can still be found, and a working tree with uncommitted changes is left alone rather than removed. doneverifiedwithdrawn
plan_create

Open a plan: the ticket the work is tracked under, or a title when there is none. Call it when an investigation has settled on what to do and the doing needs steps — then break it down with step_add. Refused when the id is taken.

ParametrTypOpis
title *string
idstringLowercase slug. Derived from the title when omitted.
keystringA ticket key such as VAR-123, when the plan is one.
repositoriesarrayWorkspace ids the plan touches; plan_claim opens its working tree in the first.
investigationIdstringThe investigation this plan came out of. Recorded on the plan so the reasoning stays one hop away.
summarystringOne sentence: what the plan does.
plan_ready

What a plan has for you to take right now, and why the rest is not available. Call this first in a session working from a plan — omit planId to see every plan at once. Never assume a step is free because it looks next.

ParametrTypOpis
planIdstring
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens; overflow is cut on a record boundary and announced. Defaults to 2000 — raise it to see a longer list.
plan_renew

Say you are still working. Call it during a long step — a claim nobody renews lapses, and the step is handed to somebody else while you are mid-edit.

ParametrTypOpis
planId *string
stepId *string
bystring
ttlMinutesinteger
plan_status

What the plan says was done against what the repository shows. Use before trusting a plan you did not watch being executed, and after a session that ended badly.

ParametrTypOpis
planId *string

rag

rag_context

Assemble canonical and working knowledge for one question, separated by authority, with open questions flagged by reference to the entry that holds them. Use instead of knowledge_search when you need grounded context to reason from rather than a result list. Omit both ids to use this endpoint's scope.

ParametrTypOpis
query *string
knowledgeTypestring
limitinteger
workspaceIdstring
vaultIdstring

repo

repo_callers

Who calls this symbol, with the call site. Use before changing a signature.

ParametrTypOpis
symbolId *string
limitinteger
workspaceId *string
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens in compact format; overflow is cut and announced.
repo_changed

How much of the repository the last index rebuild actually re-read: files whose extraction changed, files reused from cache, and when it ran. Use after repo_index_refresh to see whether a change reached the index; use repo_index_status to learn whether a rebuild is needed at all.

ParametrTypOpis
workspaceId *string
repo_file

One file as the index sees it: the symbols it declares in order, the files and packages it imports, and the files that import it. Use when you are about to read or change a file and want its place in the graph first; use repo_symbol_get for one symbol.

ParametrTypOpis
path *stringRepository-relative path, as repo_symbol_search reports it.
workspaceId *string
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens in compact format; overflow is cut and announced.
repo_impact

What breaks if this symbol changes, walked outward to a depth you choose. Use to size a change before making it.

ParametrTypOpis
symbolId *string
depthinteger
limitinteger
workspaceId *string
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens in compact format; overflow is cut and announced.
repo_index_refresh

Rebuild the repository index. Use when repo_index_status reports stale, or after changing files you then need to query.

ParametrTypOpis
workspaceId *string
repo_index_status

Check whether a repository index exists and is current. Call before relying on any other repo_* tool.

ParametrTypOpis
workspaceId *string
repo_name_subsystems

Name the subsystems repo_unnamed_subsystems handed you: `names` maps each fingerprint to two to five plain words for what the group is about, never a symbol name you were shown and never the same name twice. Use once you have read enough to say. A refused name comes back with its reason, not as an error.

ParametrTypOpis
names *objectFingerprint to name, as repo_unnamed_subsystems reported the fingerprints.
workspaceId *string
repo_neighbors

Everything directly connected to a symbol, in either direction. Use to explore outward. For "who calls this" specifically, repo_callers is narrower and cheaper.

ParametrTypOpis
symbolId *string
directionstring incomingoutgoingboth
kindstring
limitinteger
workspaceId *string
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens in compact format; overflow is cut and announced.
repo_overview

Map a repository's subsystems and its most connected symbols. Call this first when you need to understand how a codebase is organised, before searching for individual symbols.

ParametrTypOpis
limitintegerMaximum communities to return, largest first. Default 12; pass a higher number to see the smaller ones.
workspaceId *string
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens in compact format; overflow is cut and announced.
repo_references

Every reference to a symbol, including ones the indexer could not resolve to an exact target. Use when repo_callers looks suspiciously short.

ParametrTypOpis
symbolId *string
limitinteger
workspaceId *string
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens in compact format; overflow is cut and announced.
repo_routes

Every HTTP route (Express, NestJS, FastAPI, Flask, Spring, ASP.NET) and Electron IPC channel the index found, with handler, file and line. Use to find what handles an endpoint or channel; use repo_symbol_search when you know the handler's name.

ParametrTypOpis
querystringKeep rows whose path, channel, method, handler or file contains this.
workspaceId *string
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens in compact format; overflow is cut and announced.
repo_symbol_get

Full detail for one symbol, with how many relationships point at it. Use after repo_symbol_search to confirm you have the right symbol before exploring it.

ParametrTypOpis
symbolId *string
workspaceId *string
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens in compact format; overflow is cut and announced.
repo_symbol_search

Find a symbol by name, signature, kind or path. Use instead of files_search when you are looking for a definition rather than arbitrary text. Test and fixture symbols are excluded unless includeTests is set.

ParametrTypOpis
query *string
kindstring
pathstring
includeTestsbooleanInclude test and fixture symbols. Default false.
limitinteger
workspaceId *string
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens in compact format; overflow is cut and announced.
repo_unnamed_subsystems

The subsystems nobody has named yet, with a sample of each one's symbols. Unnamed, a group is called after its most connected symbol — in a large one a helper like `escapeHtml`, not the subject. Use after repo_index_refresh, or when repo_overview reads like a list of function names; answer with repo_name_subsystems.

ParametrTypOpis
limitintegerHow many to return, largest first. Default 12 — one batch, and the answer says how many are waiting in all.
workspaceId *string

step

step_add

Call when breaking a plan down, or when the work turns out to need one more piece. Adds a step: what it waits on, which files it touches, and the assignment in the words it was given. Size it to land as one commit — a step too big to commit is a step nothing can confirm.

ParametrTypOpis
planId *string
id *string
title *string
intentstring
gatesarrayStep ids that must be done first.
scopearrayPaths or folders this touches. Two steps that overlap never run at once.
assignmentstringWhat was asked, verbatim. Never rewritten afterwards.
goalstring
vaultIdstring
step_log

Record what you did on a step before stopping. Call at the end of every stint, including one that failed — a stint missing from the history is indistinguishable from one that never happened.

ParametrTypOpis
planId *string
stepId *string
outcome *string
nextstring
vaultIdstring
step_resume

One step in full: what was asked, where it stands, what is next, and what the last session actually touched. Call after taking one — a claim answers with this already, so this is for picking work back up.

ParametrTypOpis
planId *string
stepId *string
vaultIdstring
step_update

Move a step on: its status, where it stands and what is next. Use at the end of a session that changed any of them, so the next one reads the state instead of inferring it.

ParametrTypOpis
planId *string
stepId *string
statusstringdone, verified and withdrawn all settle a step: they open its gates and count towards the plan. Use withdrawn for one that will not happen, rather than marking it done. blocked is stuck, not finished. readyclaimedblockeddoneverifiedwithdrawn
currentStatusstring
nextStepsstring
vaultIdstring

temp

temp_asset_read

Re-read a screenshot or other temporary asset by its resource URI, before it expires.

ParametrTypOpis
resourceUri *string

vault

vault_directory_create

Create a vault directory. Rarely needed on its own — vault_file_create makes missing parents.

ParametrTypOpis
path *string
vaultId *string
vault_file_create

Create a new vault note, failing if it already exists. Use vault_file_write instead when replacing an existing note is intended.

ParametrTypOpis
path *string
contentstring
vaultId *string
vault_file_edit

Apply several line-range edits to one vault note in one call, all or none. Take the line numbers and expectedHash from vault_file_read; ranges refer to the note as you read it. Prefer this over vault_file_replace when you know where the change goes.

ParametrTypOpis
path *string
expectedHash *stringThe hash from the read header. Refused if the note changed since.
edits *array
vaultId *string
vault_file_properties

Set or remove frontmatter keys on a vault note without sending the body. Use for status, tags and updated; use vault_file_edit for the text itself.

ParametrTypOpis
path *string
setobjectKeys to set. A list value is written as a block sequence.
unsetarrayKeys to remove.
expectedHashstringOptional. From the read header; refused if the note changed since.
vaultId *string
vault_file_read

Read one vault note, whole or a line range. Use when you already know the path; use knowledge_search when you do not.

ParametrTypOpis
path *string
offsetintegerFirst line to return, 1-based. Omit for the whole file.
limitintegerHow many lines to return from offset. Omit to read to the end.
tokenBudgetintegerMax output tokens; overflow is cut on a line boundary and announced. No default — a read is never shortened unless you ask.
lineNumbersbooleanDefault true: every line is prefixed with its number and a tab, which is where the ranges for file_edit come from. Pass false for the raw bytes, e.g. to build an oldText for file_replace.
vaultId *string
vault_file_replace

Change known exact text in a vault note, one pair or several in one call. Use when you know the text but not the line, e.g. after knowledge_search; for changes at known lines use vault_file_edit.

ParametrTypOpis
path *string
oldTextstring
newTextstring
replaceAllboolean
expectedOccurrencesinteger
replacementsarraySeveral pairs in one call. Each oldText must be found in the file as you read it.
expectedHashstringOptional. From the read header; refused if the file changed since.
vaultId *string
vault_file_write

Create or fully overwrite a vault note. Prefer vault_file_replace for edits — overwriting discards anything you did not include.

ParametrTypOpis
path *string
content *string
vaultId *string
vault_files_list

Browse one vault directory. Use when you want the shape of a folder; use vault_files_search to find a note anywhere in the vault, and knowledge_search to ask the vault a question.

ParametrTypOpis
pathstring
vaultId *string
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens; overflow is cut on a record boundary and announced. Defaults to 2000 — raise it to see a longer list.
vault_files_search

Find a note anywhere in one vault by words in it. Reads every folder, which knowledge_search does not, and answers with the path, the line in the file and the text around it. Its index holds a vault's first 5,000 notes. Use it to locate a note; use knowledge_search to ask what the rule is.

ParametrTypOpis
query *stringWords that appear inside a note. Matching is lexical, so name the terms rather than paraphrasing them.
typestringOnly notes whose frontmatter `type` is this, e.g. `decision`.
tagsarrayOnly notes carrying all of these tags. The leading # is optional.
limitintegerHow many notes to answer with. Default 20.
vaultId *string
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens; overflow is cut on a record boundary and announced. Defaults to 2000 — raise it to see a longer list.
vault_list

Discover the knowledge vaults you may read and write, with their scope and access. Call this first when you do not already have a vaultId.

ParametrTypOpis
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens; overflow is cut on a record boundary and announced. Defaults to 2000 — raise it to see a longer list.
vault_open

Show a vault or one note to the user in the Vault Viewer window. Use when the user should look at something; use vault_file_read when you need the content yourself.

ParametrTypOpis
pathstringVault-relative file path, for example 09-agent-instructions/AGENT-analyze-backend-tests.md
vaultId *string
vault_overview

What a vault holds: every folder, what belongs in each, how many notes and the most recent; read a note by its `recent[].path`, never by its title. Call it instead of walking folders, and after a search missed something. Measures what knowledge_search answers from: `indexedNotes` of `notes`, which can be 0 of 4.

ParametrTypOpis
vaultId *string

workspace

workspace_list

Discover the repositories you may touch, with their project, organization and suggested vault. Call this first when you do not already have a workspaceId. Narrow it with organization, project or q instead of taking every workspace.

ParametrTypOpis
organizationstringOrganization id, or part of its name.
projectstringProject id, or part of its name.
qstringSubstring of the workspace name or path.
formatstringOne line per record; about a quarter of json. Default compact — pass json only when you need the full objects. jsoncompact
tokenBudgetintegerMax output tokens; overflow is cut on a record boundary and announced. Defaults to 2000 — raise it to see a longer list.