
MTA:SA Documentation MCP Server
io.github.Luminaire1337由 GitHub 帳號 Luminaire1337 發布v1.0.3更新於 Oct 24, 2026
MCP server for MTA:SA documentation with intelligent search and caching
概覽
本機 MCP 伺服器,讓助理以結構化檢索與快取方式存取 Multi Theft Auto: San Andreas 的函式與事件文件。
- 可以做什麼
- 以關鍵字搜尋函式與事件,並支援關鍵字智慧擴展
- 用語意比對找出適合某項任務的函式或事件
- 取得單一或多個函式的完整文件與程式碼範例
- 依分類列出函式,並提示已棄用的 API
- 檢視或清除本機 SQLite 文件快取,並取得文件工作流程建議
- 適用情境
- 適合在撰寫或除錯 MTA:SA Lua 腳本時使用,讓助理直接查詢權威的函式與事件文件,而不必手動抓取 wiki。
- 執行需求
- 以 stdio 方式在本機執行;需要 Node.js 24+(Bun 1.3+ 可選)。透過 npm 套件 mtasa-docs-mcp 安裝,通常以 npx 啟動。未宣告需要帳號、API 金鑰或環境變數。抓取文件以填充快取需要網路存取。
安裝
在 SourceWeft 中
- 開啟 儀表板中的 MTA:SA Documentation MCP Server,將其新增到工作區。
- 為需要使用其工具的對話啟用該服務。
Desktop only,透過 STDIO。 STDIO 服務會啟動本機處理程序,因此需要 SourceWeft 桌面主機。
其他 MCP 客戶端
參照 儲存庫 中的啟動說明。
README
MTA:SA Documentation MCP Server
An MCP (Model Context Protocol) server that gives AI assistants reliable, structured access to Multi Theft Auto: San Andreas documentation.
It combines fast keyword search, semantic matching, and SQLite-backed caching so agents can discover the right APIs and fetch authoritative docs without manual wiki scraping.
Highlights
- 11 MCP tools for discovery, docs retrieval, cache operations, and workflow guidance
- Event-first discovery (
search_events,find_events_for_task) - Semantic task matching with SQLite vector search
- Smart keyword expansion (for example,
database->db*APIs) - Built-in deprecation detection and warnings
- Local SQLite cache with configurable lifetime
- CI verification gates, smoke tests, and release automation
Installation
Requirements:
- Node.js 24+
- Bun 1.3+ (optional runtime)
- pnpm 10+ (for local development)
Launcher note:
- You can launch/install via
npx,pnpx,bunx, or yarn dlx-style flows. - Runtime support is cross-runtime: Node.js (via
node:sqlite) and Bun (viabun:sqlite).
From npm (recommended)
or:
Quick install
[Add mtasa-docs MCP server to Cursor]
From source
If your environment skips optional native dependencies, run:
MCP Client Setup
Cursor (manual)
Global: ~/.cursor/mcp.json
Project: .cursor/mcp.json
VS Code (manual)
Workspace: .vscode/mcp.json
User: Command Palette -> MCP: Open User Configuration
Or add it from terminal:
Claude Code (CLI)
OpenCode (manual)
Global config file: ~/.config/opencode/opencode.json
Antigravity (manual)
Config file: ~/.gemini/antigravity/mcp_config.json
Generic MCP clients (manual)
If mtasa-docs-mcp is already published, replace the command with:
Available Tools
search_functionssearch_eventsfind_functions_for_taskfind_events_for_taskget_function_docsget_multiple_function_docsget_function_exampleslist_functions_by_categoryget_cache_statsrecommend_doc_workflowclear_cache
Development
Useful checks:
pnpm check:versions- keeppackage.jsonand MCP server version alignedpnpm check:changelog- ensureCHANGELOG.mdhas current release headingpnpm check:tool-names- prevent legacy tool naming regressionspnpm test:runtime- run integration runtime tests for Node and Bun smoke pathspnpm smoke:cross-runtime- run smoke checks against both Node and Bun runtimes
Scripts are located in scripts/ (build, smoke, release guards).
Release Flow
Release automation is handled by .github/workflows/release.yml.
- Bump version in
package.jsonandsrc/index.ts. - Move release notes from
Unreleasedinto a versioned section inCHANGELOG.mdusing## [x.y.z] - YYYY-MM-DD. - Create and push a release tag:
git tag v<version> && git push origin v<version>.
Branching policy:
- Before
v1.0.0: direct pushes tomasterare allowed. - Starting at
v1.0.0: use PR-based development for all changes tomaster.
On release tag pushes (v*.*.*), the release workflow:
- checks whether the version already exists on npm
- runs
pnpm verify:full - publishes to npm with provenance using trusted publishing (OIDC)
- publishes
server.jsonto the MCP Registry using GitHub OIDC - creates/updates the GitHub Release from
CHANGELOG.md - verifies installability of the published package and runs smoke tests
Maintainer setup for npm trusted publishing
In npm package settings, configure a trusted publisher for this repository and workflow:
- Repository:
Luminaire1337/mtasa-docs-mcp - Workflow file:
.github/workflows/release.yml - Environment (if used): match your GitHub Actions configuration
Maintainer setup for MCP Registry publishing
- Ensure
server.jsonexists at repository root and uses this package name:mtasa-docs-mcp - Configure MCP Registry ownership for
io.github.Luminaire1337/mtasa-docs-mcp - Release workflow uses
mcp-publisher login github-oidcand publishes only when the npm publish gate passes
CI Workflows
.github/workflows/ci.yml- verification on push/PR tomaster(Ubuntu + macOS) and optional live wiki integration tests on labeled PRs.github/workflows/release.yml- automated publish and GitHub release on release tags (v*.*.*)
Project Docs
AGENTS.md- architecture and contributor guidanceFEATURES.md- roadmap and ideasCHANGELOG.md- release historySECURITY.md- vulnerability disclosure policy
License
GNU General Public License v3.0. See LICENSE.
來源:README.md,提交 2360dcf
工具
0版本歷史
1- v1.0.3最新Sep 16, 2026
評分
已滿足適用檢查項的 50%
該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。
- 近 30 天內可連通25 分
請保持端點能夠回應 MCP 握手;SourceWeft 每 30 天探測一次。
- 已宣告認證方式10 分
請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。
- 已列出工具15 分
請讓伺服器在無憑證時回應 tools/list,或發布可在沙箱中無憑證啟動的軟體包。
- 描述必需15 分
- 圖示10 分
- 文件15 分
- 授權條款10 分