Skip to main content
Glama
imshashwatsingh

github-assistant-mcp

GitHub Assistant MCP

Ein kleiner, eigenständiger Model Context Protocol (MCP)-Server, der fünf schreibgeschützte Tools für einen KI-Coding-Assistenten (z. B. OpenCode) bereitstellt. Er ermöglicht es dem Assistenten, ein lokales Arbeitsverzeichnis zu durchsuchen und ein öffentliches GitHub-Profil über einen sauberen, sandboxed stdio-Transport abzurufen.

"Ein einfacher GitHub-MCP-Server für OpenCode."


Inhaltsverzeichnis


Related MCP server: agenticscope

Überblick

Der Server ist ein lokaler MCP-Server, der von OpenCode als Kindprozess gestartet wird. Er spricht das MCP-Protokoll über stdio (stdin/stdout) und registriert fünf Tools. Der Assistent ruft diese Tools auf; der Server erledigt die Arbeit (Dateisystemzugriffe, ein git diff oder einen GitHub-API-Aufruf) und gibt strukturierte Textergebnisse zurück.

Alles, was das Dateisystem betrifft, ist auf ein einziges WORKSPACE_ROOT-Verzeichnis beschränkt, sodass der Assistent niemals außerhalb des Projektordners lesen oder entkommen kann.


So funktioniert es (Architektur)

┌─────────────────────────┐         stdio (MCP/JSON-RPC)        ┌──────────────────────────────┐
│                         │  ───────────────────────────────▶  │   github-assistant  (this)   │
│     OpenCode / AI       │  tool call: get_github_profile     │                              │
│     Assistant           │                                    │  ┌────────────────────────┐  │
│                         │  ◀───────────────────────────────  │  │      McpServer          │  │
│  - sees 5 tools         │     result (JSON text)             │  │  (server.ts)            │  │
│  - calls them           │                                    │  └───────────┬────────────┘  │
│  - sandbox enforced     │                                    │              │ registerTools  │
└─────────────────────────┘                                    └──────────────┼──────────────┘
                                                                          ▼
                                                         ┌────────────────────────────────┐
                                                         │  tools.ts  (5 tool handlers)   │
                                                         └───┬──────┬──────┬──────┬─────┬──┘
                                          ┌───────────────┘      │      │      │     │
                                          ▼                      ▼      ▼      ▼     ▼
                                   ┌────────────┐        ┌────────────┐ ┌─────────┐ ┌────────────┐
                                   │ github.ts  │        │ workspace.ts│ │ git.ts │ │ paths.ts   │
                                   │ GitHub API │        │ list/read/  │ │ git diff│ │ resolve    │
                                   │ (fetch)   │        │ search      │ │         │ │ sandbox    │
                                   └─────┬──────┘        └─────┬──────┘ └────┬────┘ └─────┬──────┘
                                         │                    │            │           │
                                         ▼                    ▼            ▼           ▼
                                 api.github.com       WORKSPACE_ROOT/*   git CLI    config.ts
                                                        (files only)   (cwd=root)  WORKSPACE_ROOT

Datenfluss für einen einzelnen Tool-Aufruf:

Assistant ──JSON-RPC request──▶ McpServer
                                     │
                                     ▼
                               tool handler (tools.ts)
                                     │  validates args with zod
                                     ▼
                          business logic (github / workspace / git / paths)
                                     │  resolveWorkspacePath() enforces sandbox
                                     ▼
                          result helper (result.ts) → { content: [{ type:"text", text }] }
                                     │
                                     ▼
Assistant ◀──JSON-RPC response── McpServer

Transport & Lebenszyklus

  • Typ: local – OpenCode startet den Server als Kindprozess.

  • Transport: stdio über serveStdio() aus @modelcontextprotocol/server/stdio.

  • Startsequenz:

    1. node dist/server.js wird ausgeführt (deklariert in opencode.json) mit cwd = ".".

    2. createServer() erstellt einen McpServer namens github-assistant (v1.0.0).

    3. registerTools(server) verdrahtet die fünf Tools.

    4. serveStdio(createServer) beginnt, JSON-RPC-Nachrichten von stdin zu lesen und Ergebnisse nach stdout zu schreiben.

  • Herunterfahren: OpenCode beendet den Prozess, wenn die Sitzung endet.

Da der Prozess das Arbeitsverzeichnis von OpenCode erbt, wird WORKSPACE_ROOT zum Projektverzeichnis aufgelöst (path.resolve(process.cwd())).


Tool-Referenz

Alle Tools sind in src/tools.ts registriert und geben MCP-Textergebnisse zurück (JSON oder Klartext).

1. get_github_profile

Ruft das öffentliche GitHub-Profil des fest codierten Benutzers (imshashwatsingh) ab.

  • Eingaben: keine

  • Backend: fetch() auf https://api.github.com/users/imshashwatsingh mit Accept: application/vnd.github+json und einem User-Agent-Header.

  • Gibt zurück: Benutzername, Name, Firma, Standort, Bio, öffentliche Repos/Gists, Follower, Gefolgt, Profil-URL, Erstellungs-/Aktualisierungszeitstempel.

  • Datei: src/github.ts

2. list_files

Listet Dateien in einem Arbeitsverzeichnis bis zu einer Tiefe auf.

  • Eingaben: path (Standard "."), maxDepth (0–10, Standard 3)

  • Backend: rekursives collectFiles() in src/workspace.ts – überspringt symbolische Links (keine Schleifen) und ignoriert konfigurierte Verzeichnisse (node_modules, .git, dist, .next, coverage, .cache). Begrenzt auf MAX_RESULTS (500).

  • Gibt zurück: Arbeitsverzeichnis-Wurzel, Dateianzahl und relative Dateipfade.

  • Datei: src/workspace.ts

3. read_file

Liest eine UTF-8-Textdatei mit optionalem Zeilenbereich.

  • Eingaben: path (erforderlich), startLine (optional), endLine (optional)

  • Backend: readWorkspaceFile() – erzwingt die Sandbox, lehnt Nicht-Dateien ab, verweigert Dateien größer als MAX_FILE_SIZE (1 MB) und verweigert Binärerweiterungen. Gibt nummerierte Zeilen zurück.

  • Gibt zurück: Dateiinhalt mit Zeile: Text-Präfixen.

  • Datei: src/workspace.ts

4. search_context

Stichwortsuche im Arbeitsverzeichnis mit umgebendem Kontext.

  • Eingaben: query (erforderlich), path (Standard "."), maxResults (1–100, Standard 50), contextLines (0–10, Standard 2)

  • Backend: searchContext() sammelt Dateien, filtert reine Text- und größenbegrenzte Dateien und durchsucht dann jede Zeile (ohne Berücksichtigung der Groß-/Kleinschreibung) und erfasst contextLines ober- und unterhalb jedes Treffers.

  • Gibt zurück: Abfrage, Suchpfad, Anzahl der Treffer und Treffer mit Datei/Zeile/Kontext.

  • Datei: src/workspace.ts

5. summarize_diff

Untersucht den aktuellen Git-Diff und gibt eine strukturierte Zusammenfassung zurück.

  • Eingaben: staged (Standard false), base (optionaler Git-Ref), path (optionaler Datei-/Ordnerpfad), maxDiffChars (1000–200000, Standard 50000)

  • Backend: summarizeDiff() führt git diff --no-ext-diff --unified=3 (mit --cached / Basis-Ref / Pfadfiltern) aus WORKSPACE_ROOT aus. Statistiken werden aus dem Unified-Diff selbst geparst (kein zweiter git-Aufruf). Der Diff wird abgeschnitten, wenn er maxDiffChars überschreitet.

  • Gibt zurück: geänderte Dateien, Einfügungen, Löschungen, Statistiken pro Datei und den rohen Diff – oder { empty: true }, wenn es keine Änderungen gibt.

  • Datei: src/git.ts


Sicherheitsmodell

Der Server ist absichtlich schreibgeschützt und sandboxed:

Anliegen

Schutz

Pfad-Traversal (../../etc/passwd)

resolveWorkspacePath() (src/paths.ts) löst den Pfad auf, berechnet seine Beziehung zu WORKSPACE_ROOT und wirft einen Fehler, wenn er entkommt (..-Präfix oder absolut).

Binärdatei-Lesezugriffe

isProbablyTextFile() blockiert Nicht-Text-Erweiterungen (png, exe, pdf, …).

Übermäßig große Dateien

read_file / search_context verweigern Dateien über MAX_FILE_SIZE (1 MB).

Symlink-Schleifen

collectFiles() überspringt symbolische Links vollständig.

Verzeichnis-Aufblähung

Auflistung/Suche auf MAX_RESULTS (500) und maxDepth 10 begrenzt.

Schreiben / Löschen / Ausführen

Keine. Der Server hat keine Schreib-, Lösch- oder beliebigen Shell-Ausführungswerkzeuge. Der einzige erzeugte Prozess ist git mit einer festen Argumentstruktur.

Netzwerk

Nur ein ausgehender Aufruf: die schreibgeschützte öffentliche GitHub-API für einen festen Benutzer.

Die Sandbox-Grenze liegt vollständig in paths.ts. Jedes neue Tool, das auf das Dateisystem zugreift, muss Pfade durch resolveWorkspacePath() leiten.


Projektübersicht

  1. Einstiegspunkt – src/server.ts createServer() instanziiert McpServer und ruft registerTools() auf. serveStdio() verbindet es mit stdin/stdout.

  2. Tool-Registrierung – src/tools.ts Fünf server.registerTool(...)-Aufrufe. Jeder deklariert eine Beschreibung, ein zod-validiertes inputSchema und einen asynchronen Handler. Handler delegieren an die folgenden Module und verpacken die Ausgabe mit den Helfern aus result.ts.

  3. Konfiguration – src/config.ts Zentrale Konstanten: WORKSPACE_ROOT (aus process.cwd() aufgelöst), Größen-/Ergebnislimits, GitHub-Benutzername/-URL und Ignorier-/Binärmengen.

  4. Pfadsicherheit – src/paths.ts resolveWorkspacePath() ist das Sandbox-Tor. toWorkspaceRelative() wandelt absolute Pfade zur Anzeige wieder in arbeitsbereichsrelative Zeichenfolgen um. isProbablyTextFile() klassifiziert Dateien anhand der Erweiterung.

  5. Arbeitsbereichs-I/O – src/workspace.ts collectFiles() (rekursive Auflistung), readWorkspaceFile() (sicheres Lesen) und searchContext() (Stichwortsuche). Alle laufen über resolveWorkspacePath().

  6. GitHub – src/github.ts fetchGitHubProfile() ruft die öffentliche API auf und bildet den rohen GitHubUser auf die benutzerfreundlichere GitHubProfile-Form ab.

  7. Git – src/git.ts summarizeDiff() erstellt und führt den git diff-Befehl aus; parseDiffStats() leitet die Einfüge-/Löschzahlen pro Datei direkt aus dem Diff-Text ab.

  8. Ergebnisse – src/result.ts Kleine Helfer (textResult, errorResult, errorWithContext) standardisieren den MCP-content-Umschlag und die Fehlerkennzeichnung.


Konfiguration

opencode.json (Projektwurzel) deklariert den Server:

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "github-assistant": {
      "type": "local",
      "command": ["node", "dist/server.js"],
      "cwd": ".",
      "enabled": true
    }
  }
}

Innerhalb des Servers wird das Verhalten über Konstanten in src/config.ts eingestellt:

Konstante

Standard

Bedeutung

WORKSPACE_ROOT

path.resolve(process.cwd())

Sandbox-Wurzel (Projektverzeichnis)

MAX_FILE_SIZE

1 MB

Maximale lesbare Dateigröße

MAX_RESULTS

500

Maximale Dateien aus Liste/Suche

GITHUB_USERNAME

imshashwatsingh

Profilziel

IGNORED_DIRECTORIES

node_modules, .git, dist, …

Beim Durchlaufen übersprungen

BINARY_EXTENSIONS

png, exe, pdf, …

Als Nicht-Text behandelt


Erstellen & Ausführen

# install dependencies
npm install

# compile TypeScript -> dist/
npm run build

# start the server (used by opencode.json)
npm start

# run directly from source (no build step)
npm run dev

# the workspace must be a git repo for summarize_diff to work
git init

OpenCode erkennt den Server nach dem Erstellen (dist/server.js) automatisch aus opencode.json.


Dateistruktur

github_assistant_mcp/
├── opencode.json          # MCP server declaration for OpenCode
├── package.json           # scripts + dependencies
├── tsconfig.json          # TypeScript config
├── src/
│   ├── server.ts          # Entry point: create + serve McpServer
│   ├── tools.ts           # Registers the 5 tools + handlers
│   ├── config.ts          # Constants, limits, GitHub target
│   ├── paths.ts           # Sandbox path resolution + helpers
│   ├── workspace.ts       # list / read / search filesystem
│   ├── github.ts          # GitHub profile fetch
│   ├── git.ts             # git diff summary + stat parsing
│   └── result.ts          # MCP result/error helpers
└── dist/                  # Compiled output (npm run build)

Einschränkungen

  • get_github_profile zielt auf einen einzelnen fest codierten Benutzer; es ist nicht parametrisiert.

  • summarize_diff meldet nur Änderungen im Arbeitsverzeichnis – nicht verfolgte Dateien werden von git diff nicht angezeigt.

  • Dateisystem-Tools sind auf WORKSPACE_ROOT beschränkt; es gibt keinen projektübergreifenden Zugriff.

  • Alle Tools sind schreibgeschützt – keine Bearbeitungen, Löschungen oder Shell-Ausführungen.

  • Keine Authentifizierung: Der GitHub-Aufruf verwendet die nicht authentifizierte öffentliche API (auf 60 Anfragen/Std. pro IP begrenzt).

Available Tools

5 tools
get_github_profileA

Get the public GitHub profile of imshashwatsingh.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A4/5.0
Behavior2/5

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

No annotations are provided, so the description must disclose behavior. It only states 'Get the public GitHub profile' without mentioning authentication requirements, rate limits, return format, or side effects. The description is minimally transparent beyond the core action.

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, front-loaded sentence with no fluff. It states the action and target clearly, earning full marks for conciseness.

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 the tool's simplicity (no parameters, no output schema), the description adequately conveys what it does. It could mention the return format, but the core purpose is clear and complete for the given context.

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?

There are zero parameters, and schema coverage is effectively 100% (vacuously). The description doesn't need to explain parameters, and the baseline for 0-parameter tools is 4. It does not add any misleading parameter info.

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 uses a specific verb ('Get') and clearly identifies the resource ('public GitHub profile of imshashwatsingh'). This distinguishes it from sibling tools (file operations), making the 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 Guidelines4/5

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

The context is clear: use when you need the public GitHub profile for the specified user. No explicit exclusions or alternatives are mentioned, but the sibling tools are unrelated, so confusion is unlikely. It lacks explicit 'when not to use' guidance, hence not a 5.

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

list_filesA

List files in the workspace so the assistant can inspect the project before reading or summarizing it.

ParametersJSON Schema
NameRequiredDescriptionDefault
pathNoDirectory relative to the workspace root..
maxDepthNoMaximum directory depth to traverse.

TDQS

A3.8/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. However, it only restates the basic function without exposing any behavioral traits: it doesn't mention that it traverses directories, that output includes files and directories (or just files), whether it returns a tree or flat list, or any caveats like permission requirements. This is a significant gap for a tool with no annotations.

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, focused sentence with no filler. It immediately states the action and purpose, making it highly scannable and efficient.

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 tool is simple with only two parameters, both fully described in the schema, and no output schema. The description states the core purpose and intended usage context, which is sufficient for an agent to know when to invoke it. It doesn't detail return format, but for a listing tool that's often implicit. Overall, it's adequately complete for the tool's simplicity.

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% (both parameters are fully described in the schema), so the baseline is 3. The description adds no parameter-specific details, but the schema already provides defaults and explanation, so the description does not need to compensate. No extra semantic value is added.

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 action ('List files') and the resource ('in the workspace'), with a specific purpose ('so the assistant can inspect the project before reading or summarizing it'). This distinguishes it from sibling tools like read_file (which reads content) and search_context (which searches).

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 explicitly indicates when to use it: 'before reading or summarizing it' – providing a clear usage context. It doesn't explicitly state exclusions or alternatives, but the context is sufficient for an agent to infer it should be used first in a project inspection workflow.

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

read_fileA

Read a text file from the workspace. Use list_files first to discover available files.

ParametersJSON Schema
NameRequiredDescriptionDefault
pathYesFile path relative to the workspace root.
endLineNoOptional 1-based ending line.
startLineNoOptional 1-based starting line.

TDQS

A4/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. 'Read' clearly implies a non-destructive, read-only operation, but the description does not disclose any additional behavioral traits such as error behavior, encoding, or line range semantics (though line range is covered by the schema). It is adequate but minimal, not misleading.

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, front-loaded with the core action and followed by a useful usage hint. There is zero filler, and every word earns its place.

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 tool is simple, with a well-documented schema. The description provides sufficient context for a basic read operation, including the prerequisite step of listing files. While there is no output schema, the return value (file content) is obvious. Missing details like error handling are minor and expected for such a straightforward tool.

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 description coverage is 100% for all three parameters (path, startLine, endLine), with clear descriptions. The tool description adds no additional meaning beyond the schema, so the baseline of 3 applies as the schema does the heavy lifting.

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 verb and resource: 'Read a text file from the workspace.' This is a specific, unambiguous action that distinguishes it from sibling tools like list_files (listing) and search_context (searching). The inclusion of 'text file' also scopes the tool's domain.

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 explicitly instructs to 'Use list_files first to discover available files,' providing clear contextual guidance on when to use this tool relative to the siblings. It implies that read_file is for after discovery, though it does not explicitly state exclusions or alternative scenarios.

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

search_contextA

Search the workspace for a keyword or phrase. Returns matching files and surrounding lines so the assistant can understand relevant context.

ParametersJSON Schema
NameRequiredDescriptionDefault
pathNoOptional directory relative to the workspace root..
queryYesKeyword or phrase to search for.
maxResultsNoMaximum number of matching lines.
contextLinesNoNumber of surrounding lines to return.

TDQS

A4/5.0
Behavior3/5

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

With no annotations, the description carries the full burden for behavioral disclosure. It states the core behavior (returns matching files and surrounding lines) but does not mention edge behaviors such as case sensitivity, binary file handling, or ordering of results. It adds value beyond the schema but lacks deeper behavioral context.

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, both information-dense with no filler. It immediately states the action, then the result and purpose, making it easy to scan and understand the tool's role.

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?

Despite lacking an output schema and annotations, the description provides a sufficient high-level understanding of the return value. Combined with a fully documented schema, it is complete enough for a straightforward search tool. It could elaborate on return format, but the essentials are present.

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 description coverage is 100%, so the baseline is 3. The description echoes the 'query' and 'contextLines' concepts ('keyword or phrase', 'surrounding lines') but does not add substantive meaning beyond what the schema parameters already document. It does not clarify path defaults or maxResults behavior beyond 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 uses a specific verb ('Search') with a clear resource ('the workspace') and explicitly states the output ('matching files and surrounding lines'). This clearly distinguishes it from sibling tools like list_files and read_file, which serve different purposes.

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 implies when to use it through the clause 'so the assistant can understand relevant context,' indicating it is for gaining situational understanding via keyword search. It does not explicitly mention alternatives or exclusion cases, but for a simple search tool this is adequate context.

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

summarize_diffA

Inspect the current Git diff and return a compact structured summary of changed files, additions, deletions, and the actual diff for the assistant to summarize.

ParametersJSON Schema
NameRequiredDescriptionDefault
baseNoOptional Git ref such as main, HEAD~1, or origin/main.
pathNoOptional file or directory relative to the workspace.
stagedNoWhen true, inspect staged changes instead of working-tree changes.
maxDiffCharsNoMaximum number of diff characters returned.

TDQS

A4/5.0
Behavior4/5

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

No annotations are provided, so the description carries the transparency burden. It clearly signals a read-only operation via 'Inspect' and describes the output shape (summary plus actual diff). It does not detail edge cases such as empty diffs or repository errors, but the core behavioral contract is well communicated.

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 that front-loads the key action and outcome. Every clause adds value, and there is no fluff or redundant repetition of the tool name.

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?

With no output schema, the description correctly explains what the tool returns: changed files, additions, deletions, and the actual diff. The parameters are fully documented in the schema, so the description combined with the schema gives sufficient context for correct selection and invocation.

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 already has 100% description coverage for all four parameters, so the baseline is 3. The description adds context about the overall output but does not enrich understanding of individual parameters beyond what the schema already provides.

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 uses a specific verb ('Inspect') and resource ('current Git diff'), and clearly states it returns a structured summary with changed files, additions, deletions, and the actual diff. This distinguishes it from sibling tools like list_files and read_file, which do not operate on Git diffs.

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 phrase 'for the assistant to summarize' implies the intended use case: obtaining diff data to produce a summary. However, there is no explicit guidance about when to choose this over alternatives or when not to use it, so it relies on implication rather than clear direction.

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. 5 tool updatesv1.0.0
    • First observedget_github_profile
    • First observedlist_files
    • First observedread_file
    • First observedsearch_context
    • First observedsummarize_diff

TDQS

A3.9/5.0

Scored across 5 tools

Disambiguation5/5

The tools are clearly distinct: one fetches GitHub profile data, while the others handle local workspace file operations (listing, reading, searching, diffing). No functional overlap exists between them.

Naming Consistency5/5

All tool names follow a consistent 'verb_noun' pattern (e.g., list_files, read_file, summarize_diff). The single compound name 'get_github_profile' still adheres to the same structure, maintaining a uniform convention.

Tool Count4/5

Five tools is a reasonable number for a focused assistant, neither too sparse nor overwhelming. However, the mix leans heavily toward workspace operations rather than GitHub-specific actions, which slightly reduces appropriateness for the server's stated purpose.

Completeness2/5

The tool surface is severely incomplete for a GitHub assistant: it only covers profile retrieval and local file operations. Core GitHub workflows like issues, pull requests, repository management, and code search are entirely absent, making the toolset insufficient for its intended domain.

Maintenance

ActivitySlowing
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers

  • F
    license
    B
    quality
    D
    maintenance
    A read-only MCP server that exposes a local code workspace to AI clients via stdio, providing file browsing and text search capabilities with path safety rules.
    1
    -
  • A
    license
    Not graded
    quality
    B
    maintenance
    A local MCP server that gives AI agents access to developer tooling — GitHub (read-only), documentation search, and web research — via stdio transport.
    MIT