{
  "markdown": "# MTA:SA Documentation MCP Server\n\nAn MCP (Model Context Protocol) server that gives AI assistants reliable,\nstructured access to Multi Theft Auto: San Andreas documentation.\n\nIt combines fast keyword search, semantic matching, and SQLite-backed caching so\nagents can discover the right APIs and fetch authoritative docs without manual\nwiki scraping.\n\n## Highlights\n\n- 11 MCP tools for discovery, docs retrieval, cache operations, and workflow\n  guidance\n- Event-first discovery (`search_events`, `find_events_for_task`)\n- Semantic task matching with SQLite vector search\n- Smart keyword expansion (for example, `database` -> `db*` APIs)\n- Built-in deprecation detection and warnings\n- Local SQLite cache with configurable lifetime\n- CI verification gates, smoke tests, and release automation\n\n## Installation\n\nRequirements:\n\n- Node.js 24+\n- Bun 1.3+ (optional runtime)\n- pnpm 10+ (for local development)\n\nLauncher note:\n\n- You can launch/install via `npx`, `pnpx`, `bunx`, or yarn dlx-style flows.\n- Runtime support is cross-runtime: Node.js (via `node:sqlite`) and Bun (via `bun:sqlite`).\n\n### From npm (recommended)\n\n```bash\nnpm install -g mtasa-docs-mcp\n```\n\nor:\n\n```bash\npnpm add -g mtasa-docs-mcp\n```\n\n### Quick install\n\n[![Add mtasa-docs MCP server to Cursor](https://cursor.com/deeplink/mcp-install-dark.png)](https://cursor.com/en-US/install-mcp?name=mtasa-docs&config=eyJjb21tYW5kIjoibnB4IC15IG10YXNhLWRvY3MtbWNwIn0%3D)\n\n### From source\n\n```bash\ngit clone https://github.com/Luminaire1337/mtasa-docs-mcp.git\ncd mtasa-docs-mcp\npnpm install\npnpm build\n```\n\nIf your environment skips optional native dependencies, run:\n\n```bash\npnpm install --force\n```\n\n## MCP Client Setup\n\n### Cursor (manual)\n\nGlobal: `~/.cursor/mcp.json`\n\nProject: `.cursor/mcp.json`\n\n```json\n{\n  \"mcpServers\": {\n    \"mtasa-docs\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"mtasa-docs-mcp\"]\n    }\n  }\n}\n```\n\n### VS Code (manual)\n\nWorkspace: `.vscode/mcp.json`\n\nUser: Command Palette -> `MCP: Open User Configuration`\n\n```json\n{\n  \"servers\": {\n    \"mtasa-docs\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"mtasa-docs-mcp\"]\n    }\n  }\n}\n```\n\nOr add it from terminal:\n\n```bash\ncode --add-mcp \"{\\\"name\\\":\\\"mtasa-docs\\\",\\\"command\\\":\\\"npx\\\",\\\"args\\\":[\\\"-y\\\",\\\"mtasa-docs-mcp\\\"]}\"\n```\n\n### Claude Code (CLI)\n\n```bash\nclaude mcp add-json mtasa-docs '{\"type\":\"stdio\",\"command\":\"npx\",\"args\":[\"-y\",\"mtasa-docs-mcp\"]}'\n```\n\n### OpenCode (manual)\n\nGlobal config file: `~/.config/opencode/opencode.json`\n\n```json\n{\n  \"$schema\": \"https://opencode.ai/config.json\",\n  \"mcp\": {\n    \"mtasa-docs\": {\n      \"type\": \"local\",\n      \"command\": [\"npx\", \"-y\", \"mtasa-docs-mcp\"],\n      \"enabled\": true\n    }\n  }\n}\n```\n\n### Antigravity (manual)\n\nConfig file: `~/.gemini/antigravity/mcp_config.json`\n\n```json\n{\n  \"mcpServers\": {\n    \"mtasa-docs\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"mtasa-docs-mcp\"]\n    }\n  }\n}\n```\n\n### Generic MCP clients (manual)\n\n```json\n{\n  \"mcpServers\": {\n    \"mtasa-docs\": {\n      \"command\": \"node\",\n      \"args\": [\"/absolute/path/to/mtasa-docs-mcp/build/index.js\"]\n    }\n  }\n}\n```\n\nIf `mtasa-docs-mcp` is already published, replace the command with:\n\n```json\n{\n  \"mcpServers\": {\n    \"mtasa-docs\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"mtasa-docs-mcp\"]\n    }\n  }\n}\n```\n\n## Available Tools\n\n- `search_functions`\n- `search_events`\n- `find_functions_for_task`\n- `find_events_for_task`\n- `get_function_docs`\n- `get_multiple_function_docs`\n- `get_function_examples`\n- `list_functions_by_category`\n- `get_cache_stats`\n- `recommend_doc_workflow`\n- `clear_cache`\n\n## Development\n\n```bash\npnpm build\npnpm test\npnpm test:runtime\npnpm smoke\npnpm smoke:cross-runtime\npnpm verify\npnpm verify:full\n```\n\nUseful checks:\n\n- `pnpm check:versions` - keep `package.json` and MCP server version aligned\n- `pnpm check:changelog` - ensure `CHANGELOG.md` has current release heading\n- `pnpm check:tool-names` - prevent legacy tool naming regressions\n- `pnpm test:runtime` - run integration runtime tests for Node and Bun smoke paths\n- `pnpm smoke:cross-runtime` - run smoke checks against both Node and Bun runtimes\n\nScripts are located in `scripts/` (build, smoke, release guards).\n\n## Release Flow\n\nRelease automation is handled by `.github/workflows/release.yml`.\n\n1. Bump version in `package.json` and `src/index.ts`.\n2. Move release notes from `Unreleased` into a versioned section in\n   `CHANGELOG.md` using `## [x.y.z] - YYYY-MM-DD`.\n3. Create and push a release tag: `git tag v<version> && git push origin v<version>`.\n\nBranching policy:\n\n- Before `v1.0.0`: direct pushes to `master` are allowed.\n- Starting at `v1.0.0`: use PR-based development for all changes to `master`.\n\nOn release tag pushes (`v*.*.*`), the release workflow:\n\n- checks whether the version already exists on npm\n- runs `pnpm verify:full`\n- publishes to npm with provenance using trusted publishing (OIDC)\n- publishes `server.json` to the MCP Registry using GitHub OIDC\n- creates/updates the GitHub Release from `CHANGELOG.md`\n- verifies installability of the published package and runs smoke tests\n\n### Maintainer setup for npm trusted publishing\n\nIn npm package settings, configure a trusted publisher for this repository and\nworkflow:\n\n- Repository: `Luminaire1337/mtasa-docs-mcp`\n- Workflow file: `.github/workflows/release.yml`\n- Environment (if used): match your GitHub Actions configuration\n\n### Maintainer setup for MCP Registry publishing\n\n- Ensure `server.json` exists at repository root and uses this package name:\n  `mtasa-docs-mcp`\n- Configure MCP Registry ownership for\n  `io.github.Luminaire1337/mtasa-docs-mcp`\n- Release workflow uses `mcp-publisher login github-oidc` and publishes only\n  when the npm publish gate passes\n\n## CI Workflows\n\n- `.github/workflows/ci.yml` - verification on push/PR to `master` (Ubuntu +\n  macOS) and optional live wiki integration tests on labeled PRs\n- `.github/workflows/release.yml` - automated publish and GitHub release on\n  release tags (`v*.*.*`)\n\n## Project Docs\n\n- `AGENTS.md` - architecture and contributor guidance\n- `FEATURES.md` - roadmap and ideas\n- `CHANGELOG.md` - release history\n- `SECURITY.md` - vulnerability disclosure policy\n\n## License\n\nGNU General Public License v3.0. See `LICENSE`.\n",
  "bytes": 6212,
  "sha": "504b651251071af91e9f190fbd739bb273546380c3b31033b21a4c0b303d27fd",
  "repo_slug": "luminaire1337/mtasa-docs-mcp",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/mcp_io_github_luminaire1337_mtasa_docs_mcp_f9a031c6/readme"
}