Skip to content

MCP-Tools-Referenz

VMark stellt KI-Assistenten sieben zusammengesetzte MCP-Tools zur Verfügung: session, workspace, document, workflow, selection, browser und coherence. Zusammen decken sie das Editor-Rückgrat, den Datei- und Fenster-Lebenszyklus, CST-sichere Workflow-Bearbeitungen, gezielte Bearbeitungen der Auswahl, begrenzte Browser-Navigation und eine schreibgeschützte Sicht auf die Kohärenzschicht des Arbeitsbereichs ab.

Die frühere Oberfläche mit 12 Tools und 76 Aktionen wurde reduziert, weil dokumentinterne Formatierungs-Tools (Fettdruck, Überschriften, Tabellen usw.) Arbeit duplizieren, die KI-Agenten ohnehin trivial über einen Markdown-Roundtrip erledigen. Die vollständige Begründung steht im MCP-Pruning-Plan.

Empfohlener Arbeitsablauf

  1. Rufen Sie session.get_state einmal auf, um offene Fenster, Tabs und pro Tab {filePath, dirty, revision, kind} zu sehen.
  2. Für Markdown: document.read → überlegen → document.write (mit expected_revision für sichere Nebenläufigkeit).
  3. Für GitHub Actions YAML (kind: "yaml-workflow"): workflow.apply_patch für CST-sichere Bearbeitungen, die Kommentare und Anker bewahren; workflow.validate für actionlint-Diagnosen.
  4. Dateioperationen (Öffnen, Speichern, Schließen, Tabs wechseln) liegen auf workspace.

Mermaid-Diagramme

Wenn Sie Mermaid via MCP per KI generieren, sollten Sie den mermaid-validator MCP-Server installieren — er erkennt Syntaxfehler mit denselben Mermaid-v11-Parsern, bevor die Diagramme Ihr Dokument erreichen.


session

Einmalige Orientierung. Entdecken Sie jedes Fenster, jeden Tab und die Fähigkeiten des Servers in einem einzigen Aufruf.

get_state

Keine Argumente.

Rückgabe {windows, capabilities}:

json
{
  "windows": [
    {
      "label": "main",
      "focused": true,
      "tabs": [
        {
          "id": "tab-1",
          "filePath": "/path/to/notes.md",
          "title": "notes",
          "dirty": false,
          "revision": "rev-x7Q3aB1F",
          "kind": "markdown"
        },
        {
          "id": "tab-2",
          "filePath": "/repo/.github/workflows/ci.yml",
          "title": "ci",
          "dirty": true,
          "revision": "rev-x7Q3aB1F",
          "kind": "yaml-workflow"
        }
      ]
    }
  ],
  "capabilities": {
    "version": "<vmark-mcp-server version>",
    "supportedKinds": ["markdown", "yaml-workflow"],
    "mcpProtocol": "0.2.0"
  }
}

Der kind-Diskriminator zeigt Ihnen, ob für diesen Tab document.write (für Markdown) oder workflow.apply_patch (für yaml-workflow) zu verwenden ist.


workspace

Datei- und Fenster-Lebenszyklus. Nichts dokumentintern.

new

Einen neuen unbenannten Tab anlegen.

ParameterTypErforderlichBeschreibung
kindstringNein"markdown" (Standard) oder "yaml-workflow"
windowLabelstringNeinZielfenster; Standard ist das fokussierte

Gibt {tabId} zurück.

open

Eine Datei von der Festplatte öffnen.

ParameterTypErforderlich
filePathstringJa
windowLabelstringNein

Gibt {tabId} zurück.

save

Einen Tab unter seinem bestehenden Pfad speichern.

ParameterTypErforderlich
tabIdstringNein (Standard ist der fokussierte)

Gibt {filePath, revision} zurück.

save_as

Einen Tab unter einem neuen Pfad speichern.

ParameterTypErforderlich
tabIdstringNein
filePathstringJa

Gibt {revision} zurück.

close

Einen Tab schließen. Verwirft ungespeicherte Arbeit nicht ohne force.

ParameterTypErforderlich
tabIdstringJa
forcebooleanNein

Gibt bei Erfolg {closed: true} zurück, bzw. {closed: false, reason: "DIRTY"}, wenn der Tab ungespeicherte Änderungen hat und force nicht angegeben wurde.

switch_tab

Einen Tab aktivieren.

ParameterTypErforderlich
tabIdstringJa

focus_window

Ein Fenster fokussieren.

ParameterTypErforderlich
windowLabelstringJa

document

Lesen, schreiben, transformieren. Das Rückgrat der Oberfläche.

read

ParameterTypErforderlich
tabIdstringNein (Standard ist der fokussierte)

Gibt {content, revision, filePath, kind, dirty} zurück. Lesen Sie immer vor dem Schreiben — der revision-Token muss den nächsten write begleiten.

write

Den vollständigen Dokumentinhalt ersetzen.

ParameterTypErforderlichBeschreibung
tabIdstringNeinZiel-Tab (Standard ist der fokussierte)
contentstringJaNeuer Gesamtinhalt
expected_revisionstringNeinRevisions-Token aus dem letzten read

Wird expected_revision übergeben und das Dokument hat sich seit diesem Lesevorgang geändert, ist die Antwort eine strukturierte Fehlerhülle STALE mit der aktuellen Revision; erneut lesen und wiederholen.

json
// success
{ "revision": "rev-newAfterWrite" }

// stale
{ "error": "STALE", "message": "Document has changed since the last read", "current_revision": "rev-currentNow" }

transform

Eine deterministische Umschreibung anwenden. Aktuell werden CJK-spezifische Transformationen unterstützt (Konvertierung Vollbreite ↔ ASCII-Interpunktion, CJK ↔ Latein-Abstand).

ParameterTypErforderlichBeschreibung
tabIdstringNeinZiel-Tab
kindstringJa"cjk-format", "cjk-spacing" oder "cjk-punctuation"
expected_revisionstringNeinNebenläufigkeits-Token

cjk-format wendet die CJK-Formatierungseinstellungen des Benutzers durchgehend an. cjk-spacing fügt einzelne Leerzeichen zwischen CJK-Zeichen und benachbarten lateinischen Zeichen oder Ziffern ein. cjk-punctuation konvertiert ASCII-Interpunktion, die neben CJK-Zeichen steht, in ihre Vollbreitenform.

Gibt {revision} zurück.


workflow

actionlint-Validierung und CST-sichere chirurgische Bearbeitungen für GitHub Actions Workflow-YAML. Nur für Tabs mit kind gleich "yaml-workflow" verfügbar.

document.read / document.write funktionieren auf jedem Tab — auch bei Workflow-YAML

Das workflow-Tool ist kein Ersatz für das Lese-/Schreibgerüst. Bei einem Workflow-Tab können Sie:

  • document.read aufrufen, um den rohen YAML-Text (mit allen Kommentaren) zu erhalten
  • document.write verwenden, um ihn vollständig zu ersetzen (was Sie senden, wird wortgetreu gespeichert — Kommentare bleiben erhalten, wenn Sie sie mitschicken)
  • workflow.apply_patch einsetzen, wenn der Server selbst garantieren soll, dass Kommentare, Anker und Schlüsselreihenfolge eine Teilbearbeitung überleben

Verwenden Sie apply_patch, wenn Sie ein einzelnes Feld ändern und alles andere unangetastet lassen wollen (der Server kann keine Kommentare verlieren, die er nicht ändert). Verwenden Sie document.write, wenn Sie pauschal umschreiben oder einen neuen Workflow von Grund auf erzeugen.

apply_patch

Ein Array von IRPatch-Objekten anwenden. Patches werden über die CST-bewussten Mutatoren von VMark abgewickelt, die Kommentare, Anker und Schlüsselreihenfolge bewahren. Ein einfacher document.write auf eine YAML-Datei würde sie verlieren.

ParameterTypErforderlich
tabIdstringNein
patchesIRPatch[]Ja
expected_revisionstringNein

IRPatch ist eine diskriminierte Vereinigung (kind-Feld). Unterstützte Arten:

kindWirkung
workflow.setTop-Level-Felder setzen ({path, value}) — name, env.X usw.
job.setEin Feld eines Jobs setzen ({jobId, path, value})
step.setEin Feld eines Steps setzen ({jobId, stepIndex, path, value})
with.setEinen Schlüssel im with:-Block eines Steps setzen ({jobId, stepIndex, key, value})
with.removeEinen Schlüssel aus dem with:-Block eines Steps entfernen
needs.add / needs.removeEine Job-ID zu needs: hinzufügen oder daraus entfernen
trigger.setFiltersEin Trigger-Filter-Array ersetzen — Branches, Pfade, Typen usw. ({event, filter, value: string[]})

Gibt bei Erfolg {revision} zurück oder eine strukturierte Fehlerhülle STALE / INVALID_PATCH / NOT_WORKFLOW.

validate

actionlint über das Workflow-YAML laufen lassen.

ParameterTypErforderlich
tabIdstringNein

Gibt {ok, diagnostics, binaryAvailable} zurück. Jede Diagnose trägt {line, col, message, severity}. binaryAvailable: false bedeutet, dass actionlint lokal nicht installiert ist; Installation über Homebrew oder die Upstream-Releases.


coherence

Eine schreibgeschützte Sicht auf die Kohärenzschicht des Arbeitsbereichs — welche abgeleiteten Dokumente gegenüber den Upstreams, aus denen sie erzeugt wurden, veraltet sind. Keine der beiden Aktionen verändert Dokumente, das Ledger oder irgendeinen Editor-Zustand; beide werden vollständig vom Rust-Backend aus dem Kernel des jeweiligen Arbeitsbereichs beantwortet und funktionieren daher auch, wenn kein Editor-Fenster im Vordergrund ist.

Zwei weitere schreibgeschützte Aktionen legen die semantische Schicht offen:

  • claims — die aktuellen Kanon-Aussagen: {claim, entryId, statement, maturity, invalidAt, visible}. Nur established-Aussagen schränken semantische Prüfungen ein; visible spiegelt den Default-Kontext wider.
  • contexts — die Kontextmenge (der implizite default ist immer vorhanden): {id, name, parent, enforcement, visibleClaims, errors}.

Eine verändernde Aktion, durch Delegation abgesichert:

  • resolve — eine aktive veraltete Kante als ausdrücklich delegierter Agent auflösen: {workspace_root, txf, input, resolution: "accept-newer" | "waive", reason? (required for waive)}. Die Autorisierung ist fail-closed: Der Eigentümer des Arbeitsbereichs muss Ihrer authentifizierten Bridge-Identität eine aktive, nicht abgelaufene Delegation erteilt haben, die die Art der Auflösung abdeckt (in der App erteilt, aus der Aufschlüsselung), und die Kante muss aktiv sein. Jede delegierte Auflösung wird im Audit-Log der Erteilung zugeordnet. Aussagen- und Kontextmutationen werden nie offengelegt — der Kanon bleibt menschengesteuert.

Alle Aktionen erfordern workspace_root: den absoluten Pfad des abzufragenden Arbeitsbereichs. Sie erfahren ihn über session.get_state (das filePath der offenen Tabs) oder das workspace-Tool. Ein Pfad, der fehlt, nicht absolut ist oder kein Verzeichnis ist, wird mit einem einfachen String-Fehler abgelehnt.

status

Kernel-Statuszähler für einen Arbeitsbereich.

ParameterTypErforderlichBeschreibung
workspace_rootstringJaAbsoluter Pfad des abzufragenden Arbeitsbereichs

Rückgabe:

json
{
  "initialized": true,
  "objects": 12,
  "open_items": 2,
  "quarantined": 0,
  "writer": "0198c0de-0000-7000-8000-000000000001"
}
FeldBedeutung
initializedfalse, wenn der Arbeitsbereich noch kein Kohärenz-Ledger hat (kein .vmark/-Verzeichnis). Alle Zähler außer objects sind dann 0.
objectsVerfolgte Objekte (Dateien mit einer Kohärenz-Identität).
open_itemsAktive, nicht mehr frische Kanten — die aktuelle Größe der Aufschlüsselung.
quarantinedBeim letzten Lesen unter Quarantäne gestellte fehlerhafte Ledger-Zeilen.
writerDie Writer-ID (UUID) dieser Installation.

edges

Die Aufschlüsselung: jede aktive Abhängigkeitskante, deren Upstream sich bewegt hat. Führt zuerst einen Scan-Abgleich aus, sodass die Antwort die Dateien auf der Festplatte zum Aufrufzeitpunkt widerspiegelt.

ParameterTypErforderlichBeschreibung
workspace_rootstringJaAbsoluter Pfad des abzufragenden Arbeitsbereichs

Rückgabe — ein Array, leer, wenn alles kohärent ist:

json
[
  {
    "txf": "0198c0de-0000-7000-8000-00000000000a",
    "input": 0,
    "upstream": "0198c0de-0000-7000-8000-00000000000b",
    "upstream_path": "characters/elena.md",
    "pinned": "rev-a1b2c3",
    "downstream": "0198c0de-0000-7000-8000-00000000000c",
    "downstream_path": "scenes/chapter-3.md",
    "downstream_rev": "rev-d4e5f6",
    "state": "version-stale"
  }
]
FeldBedeutung
txf / inputDer Transformationseintrag und der Eingabe-Slot, die diese Kante identifizieren (an die Auflösungsaktionen in der App übergeben).
upstream / upstream_pathDas Objekt, von dem der Downstream abhängt, und sein zuletzt bekannter Pfad.
pinnedDie Upstream-Revision, aus der der Downstream erzeugt wurde.
downstream / downstream_path / downstream_revDas abgeleitete Objekt, sein Pfad und seine aktuelle Revision.
state"version-stale", "stale-valid", "stale-contradicted", "stale-unknown", "waived", "diverged", "diverged-multi-head" oder "unpinnable".

Das Auflösen einer Kante (Neuere übernehmen / Aussetzen) ist eine menschliche Aktion in VMarks Aufschlüsselungsansicht — sie ist bewusst nicht über MCP verfügbar.


Fehler

Es treten zwei Fehlerformen auf:

Domänenfehler — setzen success: false und liefern eine JSON-codierte Hülle in error:

json
{ "error": "STALE", "message": "...", "current_revision": "rev-..." }

Argument-Form-Fehler — bei fehlenden oder ungültigen Pflichtargumenten (z. B. document.write ohne content-Feld) ist error eine einfache Zeichenkette, die das Problem beschreibt. Die strukturierte Hülle bleibt domänenspezifischen Bedingungen vorbehalten.

CodeFormBedeutung
STALEHülleexpected_revision stimmte nicht; erneut lesen und wiederholen
INVALID_PATCHHülleworkflow.apply_patch hat ein fehlerhaftes patches-Array erhalten
INVALID_TABHülletabId konnte nicht aufgelöst werden
INVALID_PATHHülleworkspace.open hat einen filePath erhalten, der nicht gelesen werden konnte
NOT_WORKFLOWHülleworkflow.* wurde auf einem Tab aufgerufen, der kein YAML-Workflow ist
READ_ONLYHülleEine Mutation wurde auf einem schreibgeschützten Dokument versucht
INTERNALHülleUnerwarteter Handler-Fehler
(einfache Zeichenkette)stringPflichtargument fehlt oder hat falschen Typ