MTA:SA Documentation MCP Server
MTA:SA Documentation MCP Server
MCP-сервер (Model Context Protocol), предоставляющий ИИ-ассистентам надежный структурированный доступ к документации Multi Theft Auto: San Andreas.
Он сочетает в себе быстрый поиск по ключевым словам, семантическое сопоставление и кэширование на базе SQLite, чтобы агенты могли находить нужные API и получать официальную документацию без ручного парсинга вики.
Основные возможности
11 инструментов MCP для поиска, получения документации, операций с кэшем и руководства по рабочим процессам
Поиск, ориентированный на события (
search_events,find_events_for_task)Семантическое сопоставление задач с помощью векторного поиска SQLite
Интеллектуальное расширение ключевых слов (например,
database->db*API)Встроенное обнаружение устаревших функций и предупреждения
Локальный кэш SQLite с настраиваемым временем жизни
Проверки CI, дымовые тесты и автоматизация релизов
Related MCP server: Documentation Retrieval MCP Server (DOCRET)
Установка
Требования:
Node.js 24+
Bun 1.3+ (опциональная среда выполнения)
pnpm 10+ (для локальной разработки)
Примечание по запуску:
Вы можете запускать/устанавливать через
npx,pnpx,bunxили потоки в стиле yarn dlx.Поддержка сред выполнения: Node.js (через
node:sqlite) и Bun (черезbun:sqlite).
Из npm (рекомендуется)
npm install -g mtasa-docs-mcpили:
pnpm add -g mtasa-docs-mcpБыстрая установка

Из исходного кода
git clone https://github.com/Luminaire1337/mtasa-docs-mcp.git
cd mtasa-docs-mcp
pnpm install
pnpm buildЕсли ваша среда пропускает опциональные нативные зависимости, выполните:
pnpm install --forceНастройка MCP-клиента
Cursor (вручную)
Глобально: ~/.cursor/mcp.json
Проект: .cursor/mcp.json
{
"mcpServers": {
"mtasa-docs": {
"command": "npx",
"args": ["-y", "mtasa-docs-mcp"]
}
}
}VS Code (вручную)
Рабочая область: .vscode/mcp.json
Пользователь: Палитра команд -> MCP: Open User Configuration
{
"servers": {
"mtasa-docs": {
"command": "npx",
"args": ["-y", "mtasa-docs-mcp"]
}
}
}Или добавьте через терминал:
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 (вручную)
Глобальный файл конфигурации: ~/.config/opencode/opencode.json
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"mtasa-docs": {
"type": "local",
"command": ["npx", "-y", "mtasa-docs-mcp"],
"enabled": true
}
}
}Antigravity (вручную)
Файл конфигурации: ~/.gemini/antigravity/mcp_config.json
{
"mcpServers": {
"mtasa-docs": {
"command": "npx",
"args": ["-y", "mtasa-docs-mcp"]
}
}
}Универсальные MCP-клиенты (вручную)
{
"mcpServers": {
"mtasa-docs": {
"command": "node",
"args": ["/absolute/path/to/mtasa-docs-mcp/build/index.js"]
}
}
}Если mtasa-docs-mcp уже опубликован, замените команду на:
{
"mcpServers": {
"mtasa-docs": {
"command": "npx",
"args": ["-y", "mtasa-docs-mcp"]
}
}
}Доступные инструменты
search_functionssearch_eventsfind_functions_for_taskfind_events_for_taskget_function_docsget_multiple_function_docsget_function_exampleslist_functions_by_categoryget_cache_statsrecommend_doc_workflowclear_cache
Разработка
pnpm build
pnpm test
pnpm test:runtime
pnpm smoke
pnpm smoke:cross-runtime
pnpm verify
pnpm verify:fullПолезные проверки:
pnpm check:versions— синхронизация версийpackage.jsonи MCP-сервераpnpm check:changelog— проверка наличия заголовка текущего релиза вCHANGELOG.mdpnpm check:tool-names— предотвращение регрессий в именовании устаревших инструментовpnpm test:runtime— запуск интеграционных тестов среды выполнения для Node и Bunpnpm smoke:cross-runtime— запуск дымовых проверок для сред Node и Bun
Скрипты расположены в scripts/ (сборка, дымовые тесты, защитные механизмы релиза).
Процесс релиза
Автоматизация релиза обрабатывается через .github/workflows/release.yml.
Увеличьте версию в
package.jsonиsrc/index.ts.Перенесите примечания к выпуску из
Unreleasedв версию вCHANGELOG.md, используя## [x.y.z] - YYYY-MM-DD.Создайте и отправьте тег релиза:
git tag v<version> && git push origin v<version>.
Политика ветвления:
До
v1.0.0: разрешены прямые пуши вmaster.Начиная с
v1.0.0: используйте разработку через PR для всех изменений вmaster.
При пуше тега релиза (v*.*.*) рабочий процесс релиза:
проверяет, существует ли версия в npm
запускает
pnpm verify:fullпубликует в npm с подтверждением происхождения через доверенную публикацию (OIDC)
публикует
server.jsonв реестр MCP с использованием GitHub OIDCсоздает/обновляет GitHub Release из
CHANGELOG.mdпроверяет возможность установки опубликованного пакета и запускает дымовые тесты
Настройка для сопровождающего (доверенная публикация npm)
В настройках пакета npm настройте доверенного издателя для этого репозитория и рабочего процесса:
Репозиторий:
Luminaire1337/mtasa-docs-mcpФайл рабочего процесса:
.github/workflows/release.ymlОкружение (если используется): должно соответствовать конфигурации GitHub Actions
Настройка для сопровождающего (публикация в реестре MCP)
Убедитесь, что
server.jsonсуществует в корне репозитория и использует имя пакета:mtasa-docs-mcpНастройте владение в реестре MCP для
io.github.Luminaire1337/mtasa-docs-mcpРабочий процесс релиза использует
mcp-publisher login github-oidcи публикует только после прохождения проверки npm
CI-рабочие процессы
.github/workflows/ci.yml— проверка при пуше/PR вmaster(Ubuntu + macOS) и опциональные тесты интеграции с живой вики для помеченных PR.github/workflows/release.yml— автоматическая публикация и GitHub-релиз при пуше тегов (v*.*.*)
Документация проекта
AGENTS.md— архитектура и руководство для участниковFEATURES.md— дорожная карта и идеиCHANGELOG.md— история релизовSECURITY.md— политика раскрытия уязвимостей
Лицензия
GNU General Public License v3.0. См. LICENSE.
Available Tools
11 toolsclear_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
Scored across 11 tools
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.
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.
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.
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
Related MCP Connectors
Driflyte MCP server which lets AI assistants query topic-specific knowledge from web and GitHub.
An MCP server that gives your AI access to the source code and docs of all public github repos
An MCP server that integrates with Discord to provide AI-powered features.
Augments MCP Server - A comprehensive framework documentation provider for Claude Code
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceAn MCP server implementation that provides tools for retrieving and processing documentation through vector search, enabling AI assistants to augment their responses with relevant documentation context20 npm263MIT
- AlicenseNot gradedqualityDmaintenanceAn MCP server that enables AI assistants to access up-to-date documentation for Python libraries like LangChain, LlamaIndex, and OpenAI through dynamic fetching from official sources.1MIT
- AlicenseNot gradedqualityDmaintenanceAn MCP server that provides full-text search over documentation using Whoosh, enabling AI assistants to find up-to-date, authoritative answers.MIT
- AlicenseAqualityDmaintenanceAn MCP server that serves documentation and enables AI-powered search, Q\&A, and document analysis for developer tools and guides.54MIT