Skip to main content
Glama
MTA:SA Documentation MCP Server

MTA:SA Documentation MCP Server

MTA:SA Dokumentations-MCP-Server

Ein MCP-Server (Model Context Protocol), der KI-Assistenten zuverlässigen, strukturierten Zugriff auf die Dokumentation von Multi Theft Auto: San Andreas bietet.

Er kombiniert schnelle Stichwortsuche, semantischen Abgleich und SQLite-basiertes Caching, sodass Agenten die richtigen APIs finden und maßgebliche Dokumentationen abrufen können, ohne manuell das Wiki durchsuchen zu müssen.

Highlights

  • 11 MCP-Tools für Suche, Dokumentationsabruf, Cache-Operationen und Workflow-Anleitungen

  • Ereignisbasierte Suche (search_events, find_events_for_task)

  • Semantischer Aufgabenabgleich mit SQLite-Vektorsuche

  • Intelligente Keyword-Erweiterung (zum Beispiel database -> db* APIs)

  • Integrierte Erkennung und Warnung bei veralteten Funktionen (Deprecation)

  • Lokaler SQLite-Cache mit konfigurierbarer Lebensdauer

  • CI-Verifizierungsschranken, Smoke-Tests und Release-Automatisierung

Related MCP server: Documentation Retrieval MCP Server (DOCRET)

Installation

Anforderungen:

  • Node.js 24+

  • Bun 1.3+ (optionale Laufzeitumgebung)

  • pnpm 10+ (für die lokale Entwicklung)

Hinweis zum Launcher:

  • Sie können den Start/die Installation über npx, pnpx, bunx oder yarn dlx-Style-Flows durchführen.

  • Die Laufzeitunterstützung ist plattformübergreifend: Node.js (via node:sqlite) und Bun (via bun:sqlite).

Von npm (empfohlen)

npm install -g mtasa-docs-mcp

oder:

pnpm add -g mtasa-docs-mcp

Schnellinstallation

Add mtasa-docs MCP server to Cursor

Aus dem Quellcode

git clone https://github.com/Luminaire1337/mtasa-docs-mcp.git
cd mtasa-docs-mcp
pnpm install
pnpm build

Falls Ihre Umgebung optionale native Abhängigkeiten überspringt, führen Sie aus:

pnpm install --force

MCP-Client-Einrichtung

Cursor (manuell)

Global: ~/.cursor/mcp.json

Projekt: .cursor/mcp.json

{
  "mcpServers": {
    "mtasa-docs": {
      "command": "npx",
      "args": ["-y", "mtasa-docs-mcp"]
    }
  }
}

VS Code (manuell)

Arbeitsbereich: .vscode/mcp.json

Benutzer: Befehlspalette -> MCP: Open User Configuration

{
  "servers": {
    "mtasa-docs": {
      "command": "npx",
      "args": ["-y", "mtasa-docs-mcp"]
    }
  }
}

Oder fügen Sie es über das Terminal hinzu:

code --add-mcp "{\"name\":\"mtasa-docs\",\"command\":\"npx\",\"args\":[\"-y\",\"mtasa-docs-mcp\"]}"

Claude Code (CLI)

claude mcp add-json mtasa-docs '{"type":"stdio","command":"npx","args":["-y","mtasa-docs-mcp"]}'

OpenCode (manuell)

Globale Konfigurationsdatei: ~/.config/opencode/opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "mtasa-docs": {
      "type": "local",
      "command": ["npx", "-y", "mtasa-docs-mcp"],
      "enabled": true
    }
  }
}

Antigravity (manuell)

Konfigurationsdatei: ~/.gemini/antigravity/mcp_config.json

{
  "mcpServers": {
    "mtasa-docs": {
      "command": "npx",
      "args": ["-y", "mtasa-docs-mcp"]
    }
  }
}

Generische MCP-Clients (manuell)

{
  "mcpServers": {
    "mtasa-docs": {
      "command": "node",
      "args": ["/absolute/path/to/mtasa-docs-mcp/build/index.js"]
    }
  }
}

Falls mtasa-docs-mcp bereits veröffentlicht ist, ersetzen Sie den Befehl durch:

{
  "mcpServers": {
    "mtasa-docs": {
      "command": "npx",
      "args": ["-y", "mtasa-docs-mcp"]
    }
  }
}

Verfügbare Tools

  • search_functions

  • search_events

  • find_functions_for_task

  • find_events_for_task

  • get_function_docs

  • get_multiple_function_docs

  • get_function_examples

  • list_functions_by_category

  • get_cache_stats

  • recommend_doc_workflow

  • clear_cache

Entwicklung

pnpm build
pnpm test
pnpm test:runtime
pnpm smoke
pnpm smoke:cross-runtime
pnpm verify
pnpm verify:full

Nützliche Prüfungen:

  • pnpm check:versions - hält package.json und die MCP-Server-Version synchron

  • pnpm check:changelog - stellt sicher, dass CHANGELOG.md die aktuelle Release-Überschrift enthält

  • pnpm check:tool-names - verhindert Regressionen bei der Benennung von Legacy-Tools

  • pnpm test:runtime - führt Integrations-Laufzeittests für Node- und Bun-Smoke-Pfade aus

  • pnpm smoke:cross-runtime - führt Smoke-Checks für Node- und Bun-Laufzeitumgebungen aus

Skripte befinden sich in scripts/ (Build, Smoke, Release-Schutz).

Release-Ablauf

Die Release-Automatisierung wird durch .github/workflows/release.yml gehandhabt.

  1. Version in package.json und src/index.ts erhöhen.

  2. Release-Notizen von Unreleased in einen versionierten Abschnitt in CHANGELOG.md verschieben, unter Verwendung von ## [x.y.z] - YYYY-MM-DD.

  3. Einen Release-Tag erstellen und pushen: git tag v<version> && git push origin v<version>.

Branching-Richtlinie:

  • Vor v1.0.0: Direkte Pushes auf master sind erlaubt.

  • Ab v1.0.0: Verwendung von PR-basierter Entwicklung für alle Änderungen an master.

Bei Release-Tag-Pushes (v*.*.*) führt der Release-Workflow:

  • prüft, ob die Version bereits auf npm existiert

  • führt pnpm verify:full aus

  • veröffentlicht auf npm mit Provenance unter Verwendung von Trusted Publishing (OIDC)

  • veröffentlicht server.json im MCP Registry unter Verwendung von GitHub OIDC

  • erstellt/aktualisiert das GitHub-Release aus CHANGELOG.md

  • verifiziert die Installierbarkeit des veröffentlichten Pakets und führt Smoke-Tests aus

Maintainer-Einrichtung für npm Trusted Publishing

Konfigurieren Sie in den npm-Paketeinstellungen einen Trusted Publisher für dieses Repository und diesen Workflow:

  • Repository: Luminaire1337/mtasa-docs-mcp

  • Workflow-Datei: .github/workflows/release.yml

  • Umgebung (falls verwendet): Stimmen Sie diese mit Ihrer GitHub Actions-Konfiguration ab

Maintainer-Einrichtung für MCP Registry Publishing

  • Stellen Sie sicher, dass server.json im Repository-Root existiert und diesen Paketnamen verwendet: mtasa-docs-mcp

  • Konfigurieren Sie die MCP Registry-Eigentümerschaft für io.github.Luminaire1337/mtasa-docs-mcp

  • Der Release-Workflow verwendet mcp-publisher login github-oidc und veröffentlicht nur, wenn die npm-Veröffentlichungsschranke passiert wurde

CI-Workflows

  • .github/workflows/ci.yml - Verifizierung bei Push/PR auf master (Ubuntu + macOS) und optionale Live-Wiki-Integrationstests bei markierten PRs

  • .github/workflows/release.yml - automatisierte Veröffentlichung und GitHub-Release bei Release-Tags (v*.*.*)

Projektdokumentation

  • AGENTS.md - Architektur und Leitfaden für Mitwirkende

  • FEATURES.md - Roadmap und Ideen

  • CHANGELOG.md - Release-Historie

  • SECURITY.md - Richtlinie zur Offenlegung von Sicherheitslücken

Lizenz

GNU General Public License v3.0. Siehe LICENSE.

Available Tools

11 tools
clear_cacheB

Clear the MTA:SA documentation cache for a specific function or all functions.

Inputs: function_name (required).

find_events_for_taskA

Task-to-events matcher. Use when you need event names for handlers/triggers (e.g., resource lifecycle, player joins, marker hits). Returns ranked MTA:SA events only.

Inputs: task_description (required), side, limit.

find_functions_for_taskA

Task-to-functions matcher. Use this FIRST when user intent is high-level (e.g., 'vehicle dealership', 'login panel'). Returns ranked MTA:SA functions/events optimized for follow-up documentation retrieval.

Inputs: task_description (required), limit.

get_cache_statsB

Get statistics about the MTA:SA documentation cache.

Inputs: no named parameters.

get_function_docsA

Fetch authoritative docs for exactly ONE MTA:SA function/event by canonical name. Preferred over manual web browsing. For multiple names, use get_multiple_function_docs in one call.

Inputs: function_name (required), use_cache, include_optional_arguments.

get_function_examplesA

Get only code examples for one function/event after docs lookup. Use when writing implementation snippets and tests.

Inputs: function_name (required).

get_multiple_function_docsA

Batch docs retrieval for implementation phase. Provide exact function/event names (ideally from search/find tools) and get combined authoritative docs in one response.

Inputs: function_names (required), include_examples, include_optional_arguments.

list_functions_by_categoryA

Enumerate canonical function/event names in a category. Useful for discovery when query terms are vague.

Inputs: category (required), limit.

recommend_doc_workflowA

Planner tool that tells LLMs exactly which mtasa-docs tools to call next for a given task. Use this to enforce MCP-first workflows and avoid manual wiki scraping.

Inputs: task_description (required), known_function_names.

search_eventsA

Event discovery tool. Search MTA:SA client/server events only (not regular functions), then chain into docs tools with exact event names.

Inputs: query (required), side, limit.

search_functionsA

Primary discovery tool. Search MTA:SA functions and events by name or keyword before coding. Returns canonical function names with side/category so LLMs can reliably chain into docs tools.

Inputs: query (required), side, limit.

Tool Schema Changelog

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

Loading tool schema changelog…

    TDQS

    A4.1/5.0

    Scored across 11 tools

    Disambiguation5/5

    Each tool has a clearly distinct purpose: search tools (search_functions, search_events) differ from task matchers (find_functions_for_task, find_events_for_task), retrieval tools handle single/batch/examples, and cache/listing/planner serve unique roles. No overlap or confusion.

    Naming Consistency5/5

    All tool names follow a consistent verb_noun snake_case pattern (e.g., clear_cache, search_functions, get_function_docs). No mixing of cases or verb styles, making the pattern predictable and easy to navigate.

    Tool Count5/5

    With 11 tools, the server is well-scoped for its documentation purpose. Each tool earns its place, covering search, retrieval, cache management, category listing, and workflow planning without excess or deficiency.

    Completeness5/5

    The tool surface provides a complete workflow: discover (search/task matchers), retrieve (docs, examples, batch), manage (cache stats/clear), explore (category listing), and plan (workflow recommender). No obvious gaps for a documentation server.

    Maintenance

    ActivityNo data
    ResponsivenessOutdated data

    Related MCP Connectors

    Related MCP Servers