Skip to main content

MCP server for VGameKit — searchable docs and tools for Unity game development

Project description

vgamekit-mcp

MCP server for VGameKit — provides searchable documentation and tools for Unity developers using VGameKit.

No API keys required. Semantic search uses a local model (all-MiniLM-L6-v2, ~90 MB downloaded once on first use).


Installation

Requirements

  • uv installed
  • Claude Code, Cursor, or any other MCP-compatible AI tool

1. Install uv (if you haven't already)

macOS / Linux:

curl -LsSf https://astral.sh/uv/install.sh | sh

Windows:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

2. Add to your .mcp.json

In your project's root directory, add the following to .mcp.json (create the file if it doesn't exist):

{
  "mcpServers": {
    "vgamekit": {
      "command": "uvx",
      "args": ["vgamekit-mcp"]
    }
  }
}

If you already have other MCP servers configured, just add the "vgamekit" block inside your existing "mcpServers" object.

3. Restart your AI tool

Restart Claude Code or whichever tool you use for the .mcp.json changes to take effect.

On first run, the embedding model is downloaded (~90 MB, one time only). Subsequent starts are instant.


Tools

Tool Description
search_docs Semantic search across all documentation ("how do I register a service")
get_doc Retrieve the full content of a specific documentation page
list_docs List all pages, optionally filtered by category
search_code_patterns Semantic search over C# code examples ("create a process flow")
get_known_bugs Return the list of known bugs and anti-patterns in VGameKit

Example usage

You can ask your AI assistant things like:

  • "How do I register a service in VGameKit?"
  • "Show me how to use AbsAppManager."
  • "Give me a code example for creating a process flow."
  • "What are the known bugs in VGameKit?"

Troubleshooting

uvx: command not found — uv is not installed. Follow the installation step above.

Slow first search — The embedding model is being downloaded (~90 MB). This happens once. Subsequent queries are instant.

Server not starting — Check your .mcp.json syntax. The file must be valid JSON.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vgamekit_mcp-0.1.2.tar.gz (775.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vgamekit_mcp-0.1.2-py3-none-any.whl (703.1 kB view details)

Uploaded Python 3

File details

Details for the file vgamekit_mcp-0.1.2.tar.gz.

File metadata

  • Download URL: vgamekit_mcp-0.1.2.tar.gz
  • Upload date:
  • Size: 775.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for vgamekit_mcp-0.1.2.tar.gz
Algorithm Hash digest
SHA256 7c329797bdf47f362d31d58ac15c3be7467e008ccec779c6d029f9e62db25a42
MD5 1bc8d8d833933279ebb59988c32cb8af
BLAKE2b-256 bcfaeaad5b7c0b5585a459de5199b4aade1818c1158d7d194c58522eb3539fce

See more details on using hashes here.

File details

Details for the file vgamekit_mcp-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: vgamekit_mcp-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 703.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for vgamekit_mcp-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 53e2943c536f73360af74ec06b647e3f656eadc5832b0004fbcaf0956dade94a
MD5 c435495558e966492190cc9e99228e12
BLAKE2b-256 b253a41877288e7d0d0df45779e8585be8caef442cf14fe3ff9d0743530ca035

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page