Skip to main content
Glama
niallr12

engineering-knowledge-mcp

by niallr12

Engineering Knowledge MCP

Ein sehr leichtgewichtiger lokaler MCP-Server, der Coding-Agenten (Claude Code, GitHub Copilot usw.) eine gemeinsame Engineering-Wissensbasis zum Suchen und Aktualisieren bietet – interne Konventionen, API-Details, Infra-Konfiguration, Auth-Abläufe, lokales Dev-Setup usw.

Das Wissen liegt als einfache Markdown-Dateien in diesem Git-Repository. Der MCP-Server ist eine dünne, zustandslose Lese-/Schreibschicht über das Dateisystem – mehr nicht.

1. Was das tut

  • Coding-Agenten können die Wissensbasis durchsuchen, statt über interne Konventionen zu raten oder den Benutzer zu bitten, sich zu wiederholen.

  • Agenten können neue Fakten mit fast null Reibung festhalten (ein Tool-Aufruf, ohne wissen zu müssen, wohin der Fakt gehört).

  • Agenten können strukturierte Wissensdokumente deterministisch erstellen und aktualisieren.

  • Alles ist Markdown in Git, also auch ohne den MCP-Server nützlich – grep, lesen, bearbeiten, Diffs prüfen, committen, PR erstellen, genau wie Code.

Related MCP server: context-book

2. Architektur

engineering-knowledge-mcp/
├── knowledge/           # the knowledge base itself (Markdown, organized by topic area)
│   ├── api/
│   ├── cloud/
│   ├── data/
│   ├── frontend/
│   └── general/
├── inbox/
│   └── knowledge-inbox.md   # low-friction capture target; triage manually into knowledge/
├── src/
│   ├── index.ts         # MCP server entrypoint (stdio transport)
│   ├── paths.ts         # path sanitization / traversal protection
│   ├── knowledge.ts     # search, get, create, update, capture logic
│   └── tools/index.ts   # MCP tool registration + input schemas
├── test/                # node:test unit tests
├── CLAUDE.md            # agent instructions auto-loaded by Claude Code when working in this repo
├── package.json
└── tsconfig.json

Design-Entscheidungen, bewusst:

  • MCP nur über stdio. Kein HTTP-Server, kein Express – der Client (Claude Code, Copilot, MCP Inspector) startet diesen Prozess und spricht JSON-RPC über stdin/stdout.

  • Keine Datenbank, keine Embeddings, kein Vektor-Store. Die Suche ist case-insensitives Token-Matching über Markdown-Abschnitte, bei Bedarf berechnet. Das ist in der Größenordnung von zehn bis hundert kleinen Dokumenten völlig ausreichend, und es bedeutet, dass es keinen Index gibt, der mit den Dateien auf der Platte synchron gehalten werden muss – die Dateien sind immer die Quelle der Wahrheit.

  • Kein In-Memory-Index, kein Dateisystem-Watching. Jeder Tool-Aufruf liest bei Aufrufzeit, was er braucht, von der Platte. Einfacher und bei dieser Größenordnung günstig.

  • Keine automatischen Git-Commits. Tool-Aufrufe berühren nur den Arbeitsbaum. Review und Commit/Push liegen bei dir. (Das Design lässt Raum, später Auto-Commit oder PR-Erstellung hinzuzufügen, ohne die Tool-Verträge zu ändern.)

Hinweis zum offiziellen SDK

Die Kurzbeschreibung erwähnte @modelcontextprotocol/server; das tatsächlich veröffentlichte Paket ist @modelcontextprotocol/sdk (v1.30+), das dieses Projekt verwendet (McpServer + StdioServerTransport).

3. Wie Wissen gespeichert wird

Jedes Dokument ist eine Markdown-Datei unter knowledge/<bereich>/<thema>.md, mit optionalem minimalem Frontmatter:

---
title: APIM
tags:
  - api
  - apim
---

# APIM

## Base paths

Internal modelling APIs use ...

## Authentication

...

## Local development

...

Kein erforderliches Schema darüber hinaus – Frontmatter ist optional, Überschriften sind einfach normale Markdown-##-Abschnitte. search_knowledge und update_knowledge verwenden ##-Ebenen (und tiefere) Überschriften als Einheit eines „Abschnitts", sodass das Strukturieren von Dokumenten mit klaren Überschriften sowohl Suchergebnisse als auch Aktualisierungen präziser macht.

Festgehaltenes, aber noch nicht sortiertes Wissen geht als zeitgestempelte Einträge in inbox/knowledge-inbox.md. Regelmäßig (von Hand oder indem man einen Agenten um Hilfe bittet) Einträge aus dem Posteingang in richtige knowledge/-Dokumente verschieben/organisieren.

4. Ausführen

Erfordert Node.js 20+.

npm install
npm run build
npm start

Für lokale Iteration (läuft direkt aus TypeScript über tsx, kein Build-Schritt):

npm run dev

Beide starten den Server auf stdio und warten auf einen Client, der sich verbindet – du wirst keinen Protokollverkehr auf dem Terminal sehen; nur Start-/Diagnoselogs (auf stderr geschrieben, nie auf stdout, da stdout für MCP-Protokollmeldungen reserviert ist).

5. Testen mit MCP Inspector

Interaktive UI:

npx @modelcontextprotocol/inspector npm run dev

Das öffnet eine Browser-UI, in der du search_knowledge, list_knowledge_topics, get_knowledge, capture_knowledge, create_knowledge und update_knowledge von Hand aufrufen und ihre JSON-Schemas und Antworten inspizieren kannst.

Nicht-interaktiv / skriptbar:

npx @modelcontextprotocol/inspector --cli node dist/index.js --method tools/list

npx @modelcontextprotocol/inspector --cli node dist/index.js \
  --method tools/call --tool-name search_knowledge --tool-arg query="apim authentication"

6. Beispiel-MCP-Client-Konfiguration

Claude Code / die meisten MCP-Clients verwenden einen Konfigurationsblock wie:

{
  "mcpServers": {
    "engineering-knowledge": {
      "command": "node",
      "args": ["/absolute/path/to/engineering-knowledge-mcp/dist/index.js"]
    }
  }
}

Für die MCP-Unterstützung von GitHub Copilot verwende den äquivalenten command/args-stdio-Server-Eintrag in seiner MCP-Konfigurationsdatei. Führe npm run build zuerst aus, damit dist/index.js existiert, oder zeige command/args auf npx tsx /absoluter/pfad/zu/src/index.ts, um direkt aus dem Quellcode zu laufen.

7. Wie ein Agent die Tools verwenden sollte

Dieses Repo enthält eine CLAUDE.md mit der folgenden Anweisung, die Claude Code automatisch lädt, wenn es in diesem Repo arbeitet. Für andere Clients (Copilot usw.) füge die äquivalente Anweisung zu ihrem System-Prompt / Anweisungsdatei hinzu:

Bevor du den Benutzer nach internen Engineering-Konventionen, Infrastruktur, APIs, Authentifizierung, Plattformkonfiguration oder etablierten Entwicklungsmustern fragst, durchsuche den Engineering-Wissens-MCP. Erfinde keine internen Konfigurationswerte. Wenn der Benutzer explizit bittet, dauerhaftes Engineering-Wissen zu merken, festzuhalten oder hinzuzufügen, verwende die Schreib-Tools des Wissens-MCP.

Tool-für-Tool-Anleitung:

  • search_knowledge(query) – erste Anlaufstelle für „wie machen wir normalerweise…", „was ist unsere Konvention für…", „was ist die Basis-URL / der Auth-Ablauf für…". Gibt bewertete Abschnitte mit Dateipfaden zurück, nicht ganze Dokumente. Durchsucht auch noch nicht triagierte Einträge in inbox/knowledge-inbox.md, sodass ein kürzlich festgehaltenes Wissen auch vor der Ablage unter einem richtigen Thema auffindbar ist. Unter Dokumenten, die bereits auf Text/Überschrift passen, wird eines, dessen Frontmatter-tags auch ein Suchwort treffen, höher bewertet – Tags erhöhen die Bewertung, sie erzeugen allein keinen Treffer.

  • list_knowledge_topics() – keine Argumente; listet Pfad, Titel und Tags jedes Dokuments ohne vollständigen Inhalt auf. Verwende das, um zu stöbern, was existiert, wenn du noch keinen guten Suchbegriff hast, oder um zu prüfen, ob ein Thema bereits existiert, bevor du create_knowledge aufrufst.

  • get_knowledge(topicOrPath) – sobald du weißt (oder search_knowledge dir gesagt hat), welches Dokument du willst, hole es vollständig. Akzeptiert lockere Referenzen: "apim", "api/apim" oder "knowledge/api/apim.md".

  • capture_knowledge(content, suggestedTopic?) – verwende, wenn der Benutzer „merke dir das" / „notiere das" sagt oder eine Tatsache nennt, die es wert ist, behalten zu werden, und du ihn nicht dazu bringen willst, herauszufinden, wo sie hingehört. Es hängt einfach an den Posteingang an.

  • create_knowledge(topic, title, content) – verwende, wenn du ein wirklich neues Thema hinzufügst, das noch nicht existiert. Schlägt laut fehl, wenn das Thema bereits existiert (verwende stattdessen update_knowledge).

  • update_knowledge(topicOrPath, heading, content, mode) – das bewusst nicht natürlichsprachliche Schreib-Tool. Siehe die Design-Notiz unten.

Warum update_knowledge heading + mode statt einer Freitext-change nimmt

Die Kurzbeschreibung markierte das als etwas, das sorgfältiges Design erfordert: Das Ziel ist, dass der Agent (der ein LLM hat) entscheidet, was eine natürlichsprachliche Änderung bedeutet, nicht dass dieser Server seine eigene KI-Interpretation von Anweisungen ausführt. Also nimmt update_knowledge ein strukturelles, deterministisches Ziel:

  • topicOrPath – welches Dokument.

  • heading – der exakte ##/###/usw. Überschriftstext, der einen Abschnitt identifiziert. Wenn er nicht existiert, wird ein neuer ##-Abschnitt mit dieser Überschrift am Ende des Dokuments angehängt (damit Aktualisierungen nie still gegen leicht veraltete Dokumente fehlschlagen).

  • content – das wörtliche Markdown, das geschrieben werden soll.

  • mode: "append" (Standard) fügt content am Ende des Abschnitts hinzu, "replace" überschreibt den gesamten Abschnittsbody.

Das bedeutet, dass der aufrufende Agent erwartet wird, bereits „aktualisiere den Abschnitt zur lokalen Entwicklung, um den neuen Port zu erwähnen" in konkreten Markdown-Inhalt umgewandelt und append/replace gewählt zu haben – genau die Art von Urteilsentscheidung, die ein LLM-gestützter Client treffen kann, und genau die Art von Urteilsentscheidung, die dieser leichtgewichtige Server nicht aus einem rohen String treffen sollte.

8. Importieren einer bestehenden Wissensbasis

Wenn du bereits Notizen irgendwo hast (ein persönliches Wiki, einen Ordner mit .md-Dateien, einen Notion-Export, ein großes „Stammeswissen"-Dokument, gespeicherte Slack-Threads usw.), gibt es kein Import-Tool und kein spezielles Format, in das konvertiert werden muss – das ist bewusst nur ein Ordner mit Markdown-Dateien. Zwei Möglichkeiten, um zu starten, ungefähr in der Reihenfolge, wie viel deiner bestehenden Struktur es wert ist, erhalten zu werden:

A. Dateien direkt einfügen (am besten, wenn deine Notizen bereits einigermaßen organisiert sind)

  1. Kopiere deine bestehenden .md-Dateien in knowledge/, sortiert in diejenigen von api/ cloud/ data/ frontend/ general/, die am besten passt (oder füge neue Themenordner hinzu – nichts erzwingt die anfänglichen fünf).

  2. Füge minimales Frontmatter (title, optional tags) zu jeder hinzu, wenn es keins hat – nicht erforderlich, aber es ist günstig und get_knowledge/ Suchergebnisse lesen sich besser mit einem Titel.

  3. Zerlege sehr lange Dokumente in mit ## überschriebene Abschnitte, wenn sie es nicht bereits sind – search_knowledge und update_knowledge arbeiten beide auf der Überschriftsebene, also wird ein 10.000-Wörter-Einzelabschnitt-Wand aus Text schlechter suchen/aktualisieren als derselbe Inhalt unter ein paar klaren Überschriften aufgeteilt.

  4. Führe npm test aus (Sicherheitscheck, dass nichts kaputt ist) und probiere ein paar search_knowledge / get_knowledge-Aufrufe über den Inspector (§5) gegen deinen echten Inhalt.

  5. Prüfe den Diff und committe ihn selbst, wie jede andere Änderung an diesem Repo.

B. Einen Agenten die Migration für dich machen lassen (am besten für chaotisches/ unstrukturiertes Quellmaterial)

Zeige Claude Code (oder einem anderen Coding-Agenten, sobald dieses MCP für ihn konfiguriert ist) auf deine bestehenden Notizen und bitte ihn, sie mit den Schreib-Tools zu migrieren. Zum Beispiel:

Ich habe Engineering-Notizen in ~/notes/engineering/. Lies sie durch und verwende create_knowledge, um sie in richtige Dokumente unter knowledge/ zu verwandeln, nach Thema gruppiert. Wo etwas nicht sauber in ein bestehendes Thema passt, verwende stattdessen capture_knowledge, damit es im Posteingang landet, damit ich es überprüfen kann.

Das funktioniert gut, weil das Umwandeln von chaotischer Prosa in „einen Titel, einige Tags, ein paar klare ##-Abschnitte" genau die Art von Urteilsentscheidung ist, die ein LLM-gestützter Agent gut kann – dieselbe Begründung wie bei update_knowledge, die dieses Urteil an den Aufrufer statt an den Server delegiert (siehe §7). Der Agent kann trotzdem nicht außerhalb von knowledge// inbox/ schreiben, und jede resultierende Datei erscheint als normale unverfolgte/geänderte Datei, die du vor dem Committen überprüfen kannst – nichts wird automatisch committet.

In jedem Fall behandle den ersten Durchgang als groben Entwurf: Es ist in Ordnung (erwartet, sogar), dass capture_knowledge einen langen Posteingang produziert, den du über ein paar Sitzungen triagierst, statt zu versuchen, eine perfekte Taxonomie von Anfang an zu bekommen.

9. Sicherheitshinweise

  • Alle Lese-/Schreibvorgänge sind auf knowledge/ und inbox/ unter dem Repo-Root beschränkt. Jeder vom Aufrufer gelieferte Pfad geht durch safeResolve (src/paths.ts), das absolute Pfade, ..-Traversal, Null-Bytes und alles, was außerhalb des erlaubten Verzeichnisses auflöst, ablehnt.

  • create_knowledge bereinigt das topic in ein sicheres Dateinamensegment, bevor es verwendet wird.

  • Kein Dokumentinhalt wird jemals ausgeführt, ausgewertet oder an ein Shell-Kommando übergeben.

  • Kein Tool führt jemals ein Shell-Kommando basierend auf MCP-Eingabe aus.

  • Fehler sind explizit (z. B. „kein Wissensdokument gefunden, das X entspricht") statt auf Vermutungen zurückzufallen.

Available Tools

6 tools
capture_knowledgeCapture knowledge (low-friction inbox)A

Low-friction capture of a durable engineering fact or convention, e.g. 'When testing the modelling API locally, X must be set to Y.' Appends a timestamped entry to inbox/knowledge-inbox.md for later triage into knowledge/. Does not require knowing where the information belongs. Use when the user explicitly asks to remember, capture, or add durable engineering knowledge.

ParametersJSON Schema
NameRequiredDescriptionDefault
contentYesThe knowledge to capture, in plain language
suggestedTopicNoOptional hint about where this might eventually belong

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description bears the full burden of behavioral disclosure, and it succeeds: it states that it appends a timestamped entry to a specific file (inbox/knowledge-inbox.md) and that the entry is for later triage into knowledge/. It also clarifies that it does not require knowing where the information belongs, setting correct expectations. It could mention potential effects (e.g., file creation or append behavior) but the essential behavior is transparent.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, well-structured sentence followed by an example and a usage directive. It front-loads the core purpose, provides a concrete illustration, and adds the usage trigger without any filler. Every element earns its place, and the whole fits comfortably in a readable length.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with only two parameters, one required, no output schema, and no nested structures, the description is fully sufficient. It covers what the tool does, where it writes, when to use it, and the key benefit (low friction). Nothing an agent needs to correctly invoke this tool is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Although the schema already documents both parameters at 100% coverage, the description adds meaningful semantic context. It explains that content is a durable engineering fact or convention, gives an example, and clarifies that suggestedTopic is optional because the tool does not require knowing the target location. This goes beyond mere schema repetition and helps an agent understand how both fields interact.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb ('capture'), a target resource (durable engineering knowledge appended to inbox/knowledge-inbox.md), and a clear distinction from direct knowledge creation. It includes a concrete example that helps an agent immediately recognize what counts as appropriate input, and the sibling list (create_knowledge) reinforces the uniqueness of this tool as an inbox capture.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides explicit guidance on when to use the tool: 'Use when the user explicitly asks to remember, capture, or add durable engineering knowledge.' It also explains the benefit ('Does not require knowing where the information belongs'), which implicitly signals that create_knowledge is the alternative when topic placement is known. However, it does not explicitly list when-not-to-use conditions or name sibling alternatives, so it falls just short of a 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

create_knowledgeCreate knowledge documentA

Create a new Markdown knowledge document under knowledge/.md. Fails if a document already exists at that path (use update_knowledge instead). Topic paths are sanitized and cannot escape the knowledge directory.

ParametersJSON Schema
NameRequiredDescriptionDefault
titleYesDocument title, used in frontmatter and as the H1 if content has none
topicYesTopic path, e.g. 'api/graphql' or 'cloud/gcp'
contentYesMarkdown body content

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden and does well by disclosing the fail-if-exists behavior, path sanitization, and containment within the knowledge directory. It does not mention the success return value or authorization requirements, but those are secondary for a create operation with this level of detail.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences with no filler: the main action is front-loaded, the failure condition follows immediately, and the alternative tool is named without extra prose. Every sentence contributes essential information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description is complete for a simple create tool: it covers purpose, path behavior, failure mode, and the key alternative. The only minor gap is not describing what a successful response looks like, but the absence of an output schema makes that less critical.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already documents all three parameters. The description adds useful context for topic by explaining the knowledge/<topic>.md mapping and sanitization, but it does not significantly expand on title or content beyond what the schema already says.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names the specific action (create), the resource (Markdown knowledge document), and the exact storage location (knowledge/<topic>.md). It also explicitly contrasts itself with update_knowledge by stating the failure condition when the document already exists.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It clearly says to use update_knowledge instead when a document already exists, which gives an explicit create-vs-update routing rule. It does not explicitly contrast itself with capture_knowledge, but the failure-on-existing condition makes the intended use case clear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_knowledgeGet knowledge documentA

Retrieve the full content of a specific knowledge document by topic or path. Accepts loose references such as 'apim', 'api/apim', or 'knowledge/api/apim.md'.

ParametersJSON Schema
NameRequiredDescriptionDefault
topicOrPathYesTopic name or relative path, e.g. 'apim' or 'api/apim'

TDQS

A4.2/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It clearly indicates it is a read operation ('Retrieve'), which implies no side effects. However, it does not disclose details like error handling (e.g., behavior when topic is not found), authentication requirements, or rate limits. For a simple read tool this is adequate but not comprehensive.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is exceptionally concise, with two sentences that front-load the primary purpose and then provide illustrative examples. Every word earns its place, with no filler or redundant content. This is ideal for efficient agent parsing.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with one parameter and no output schema, the description covers the essential aspects: what it does (retrieve full content) and what inputs it accepts. It does not specify the return format (e.g., markdown text) or any failure modes, but given the simplicity of the tool, this is not a significant gap. The description is sufficient for an agent to know how to invoke it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Since schema coverage is 100%, the parameter is already well-documented in the schema with an example. The description adds value by explaining that loose references are accepted and provides additional format examples ('knowledge/api/apim.md'), which the schema does not cover. This goes beyond mere repetition and helps the agent understand the flexibility of the input.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description explicitly states the verb 'Retrieve' and the resource 'full content of a specific knowledge document', making the purpose unambiguous. It also distinguishes from siblings by focusing on retrieval of a specific document by topic/path, as opposed to search or list operations.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context on when to use the tool - when you have a specific topic or path - and gives concrete examples of accepted loose references. It does not explicitly name sibling tools or state when not to use it, but the implication is clear that this is for known references rather than discovery.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

list_knowledge_topicsList knowledge topicsA

List every knowledge document (path, title, tags) without full content. Use this to browse what topics exist before deciding what to search for, when a keyword search comes up empty, or to check whether a topic already exists before calling create_knowledge.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are present, so the description carries the full burden. It implies a read-only operation (listing without side effects) and even mentions checking existence before creation, but it does not explicitly state 'read-only' or 'non-mutating'. It is clear enough, though not fully explicit.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences and tightly packed with purpose, output details, and usage guidance. No unnecessary words or redundancy; it is efficiently structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the simplicity of the operation (no parameters, no output schema), the description provides sufficient context: what it lists, what it omits, and when to use it. It covers the essential aspects for an agent to decide and invoke correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema is empty, so there are no parameters to describe. The description adds no parameter-related information, but since schema coverage is 100% (empty), a baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool lists knowledge documents with their path, title, and tags, and explicitly excludes full content. It distinguishes from sibling tools by framing it as a browsing/pre-check operation, making its purpose unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit use cases: browsing topics before searching, when keyword search returns empty, and before calling create_knowledge. This gives clear guidance on when to select this tool over alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

search_knowledgeSearch knowledgeA

Search all engineering knowledge Markdown documents (and not-yet-triaged inbox captures) with simple case-insensitive text matching, boosted by frontmatter tag matches. Returns the strongest matching sections (not full documents) ranked by relevance, with file paths. Use this before asking the user about internal conventions, infra, APIs, auth, or platform config.

ParametersJSON Schema
NameRequiredDescriptionDefault
queryYesSearch terms, e.g. 'apim authentication' or 'aws s3 bucket policy'

TDQS

A4.7/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description discloses the matching mechanism (case-insensitive text, tag boosting), the scope (including not-yet-triaged inbox captures), and the return format (sections with file paths). It does not mention potential side effects or limitations like rate limits, but the read-only nature is strongly implied by 'Search'.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise and well-structured, consisting of two sentences that efficiently cover the tool's functionality, output, and usage context. There is no redundant or vague wording, and every clause contributes informational value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the absence of annotations and output schema, the description single-handedly provides sufficient context: it defines the search scope, matching behavior, return details, and a clear use-case. It also clarifies that it returns sections rather than full documents, which is crucial for an agent deciding between this and a document retrieval tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool description adds meaning to the single 'query' parameter by explaining that it performs case-insensitive text matching and that tag matches boost results. This goes beyond the schema's example terms, giving the agent insight into how the query is interpreted.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's function: searching all engineering knowledge Markdown documents, including inbox captures. It specifies the resource, the verb 'Search', and the output (sections with file paths), making it unambiguous and distinct from other potential tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit guidance is provided: 'Use this before asking the user about internal conventions, infra, APIs, auth, or platform config.' This tells the agent exactly when to invoke this tool, and the implicit contrast with retrieving full documents (sections vs. full documents) hints at when not to use it.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

update_knowledgeUpdate knowledge documentA

Deterministically update an existing knowledge document by targeting a specific Markdown heading. This tool does NOT interpret natural-language change requests — the caller must decide what content to write and whether to append to the section or replace it. If the heading doesn't exist, a new section is appended at the end of the document.

ParametersJSON Schema
NameRequiredDescriptionDefault
modeNo'append' adds content to the end of the section; 'replace' overwrites the section bodyappend
contentYesMarkdown content to write into the section
headingYesExact heading text to target, e.g. 'Local development'
topicOrPathYesTopic name or relative path identifying the document

TDQS

A4.1/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It discloses that the tool is deterministic, does not interpret natural language, targets a specific heading, and appends a new section if the heading is missing. This covers key operational behavior, though it does not mention permissions, error handling, or reversibility—acceptable for a low-risk knowledge document update.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is three sentences, efficient and front-loaded with the core action. The key behavioral constraints (deterministic, no NL interpretation, heading behavior) are stated without unnecessary fluff.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple update tool with 4 parameters, no output schema, and no annotations, the description covers the main operational aspects: target document, heading behavior, append/replace semantics, and the caller's responsibility. It lacks explicit mention of edge cases like handling invalid paths or partial failures, but these are not critical for a knowledge base update.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents each parameter. The description adds value beyond the schema by explaining the heading-targeting behavior (exact text, and appending a new section if not found) and by clarifying that the caller must decide between append and replace, which maps to the mode parameter but is not fully explicit in the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb (update), resource (existing knowledge document), and a precise mechanism (targeting a Markdown heading). It explicitly distinguishes itself from natural-language change requests and implies it is not for creation, which differentiates it from siblings like create_knowledge and capture_knowledge.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description clearly implies use for updating existing documents and clarifies it is deterministic, but it does not explicitly name alternatives or state when not to use it (e.g., for creating new docs, use create_knowledge). The behavioral note about appending a new section when heading is missing provides some context, but sibling differentiation is left implicit.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 6 tool updatesv0.1.0
    • First observedcapture_knowledge
    • First observedcreate_knowledge
    • First observedget_knowledge
    • First observedlist_knowledge_topics
    • First observedsearch_knowledge
    • First observedupdate_knowledge

TDQS

A4.4/5.0

Scored across 6 tools

Disambiguation5/5

All six tools have distinct purposes: searching, listing, retrieving, capturing to inbox, creating new docs, and updating existing docs. No overlapping or ambiguous functions.

Naming Consistency5/5

Tool names follow a consistent verb_noun pattern (search_knowledge, list_knowledge_topics, get_knowledge, capture_knowledge, create_knowledge, update_knowledge). Verbs clearly indicate actions and nouns correctly describe the target.

Tool Count5/5

Six tools is a well-scoped number for a knowledge management server, covering search, browse, read, capture, create, and update without unnecessary redundancy.

Completeness4/5

The tool set covers create (capture and create), read (search, list, get), and update, but lacks a delete/remove operation. This is a minor gap since knowledge bases may need to retire outdated entries, but core workflow is supported.

Maintenance

ActivitySlowing
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers

  • A
    license
    Not graded
    quality
    D
    maintenance
    Provides AI agents with a persistent, searchable knowledge library via MCP tools, allowing them to create books, manage pages, perform semantic search, and retrieve usage guides.
    5
    MIT
  • A
    license
    Not graded
    quality
    B
    maintenance
    MCP server that gives AI coding agents a git-backed markdown wiki to read and update, enabling search, read, write, verify, ingest, promote, and lint operations on versioned knowledge documents with schema validation, staleness tracking, and contradiction detection.
    4
    MIT
  • A
    license
    Not graded
    quality
    B
    maintenance
    A machine-local, agent-writable knowledge base MCP server that lets coding agents autonomously record and retrieve hard-won operational facts, incidents, and corrections as markdown pages in a git repo, with provenance, talk pages, and search.
    3 npm
    MIT