Skip to main content

Configure AI coding tools for Overwolf projects

Overwolf has introduced the ability to use AI coding assistants to help you maximize your time when developing Overwolf apps. By configuring these tools with direct access to Overwolf's type definitions and documentation, you get accurate, context-aware answers without leaving your editor, whether you're wiring up the overlay package, querying game events, or navigating the ads SDK.

Effective use of prompts​

Keep the following guidelines in mind when prompting your AI coding assistant for Overwolf specific help:

  • Always use Overwolf in the prompt. This tells your assistant to prioritize the Overwolf APIs and documentation when searching for answers.
  • Use Native or Electron in your prompt to refine results and limit them to the framework you're working with.
  • Mention documentation or API to signal the type of answer you need—one directs the assistant toward conceptual guides, the other toward type signatures and method references.
  • Include the filename or module you are working in. Knowing whether you are in the main process, a renderer, or a specific service gives the assistant more context to work with.
  • Ask explicitly for a code example when you need implementation guidance rather than an explanation—assistants default to prose unless you ask otherwise.
  • Break complex questions into steps. Ask one thing at a time rather than combining multiple questions into a single prompt.
  • Paste in the raw error text and add Fix. Your assistant can differentiate between Overwolf-related errors and general framework errors.
  • If your assistant appears stuck, use the clear or reset tools available in your IDE to prevent loops, hallucinations, or repeated failures.

Claude Code​

Claude Code integrates directly with the Overwolf docs MCP server, giving it the ability to search live documentation alongside your local type definitions. This makes it the most capable option for answering questions that require both type-level accuracy and conceptual explanation—such as understanding the full lifecycle of a GEP event or the correct sequence for initializing the overlay package.

Step 1: Create the CLAUDE.md file​

note

The configuration below is for Overwolf Native projects. Use the Electron claude.md if you are developing an Electron app.

Create CLAUDE.md in your project root and paste the following:

## Framework

This is an **Overwolf Native** project. Use `docs-ow-native-current` for all Overwolf docs MCP queries.

## API lookup order

When any question involves an Overwolf API, method, type, or interface:

1. **Search local Overwolf `.d.ts` files first**—glob `node_modules/@overwolf/**/*.d.ts` and grep for the symbol.
 These are the ground truth for what is actually installed and available in this project.

2. **Query the Overwolf docs MCP** when:
 - The symbol isn't found in the local type definitions
 - The user needs conceptual explanation, guides, or code examples beyond what types convey

## Overwolf docs MCP server

Available tool: `mcp__ow-docs-mcp__algolia_search_index_overwolf`

Always use `facet_docusaurus_tag: docs-ow-native-current` for all queries.

If the MCP server is not connected (not listed in available MCP servers), tell the user and ask them to reload Claude Code. Do NOT fall back to curl, web search, or any other method.

## General guidelines

- All Overwolf packages live under the `@overwolf` npm scope—this is always the right place to start when exploring what APIs are available.
- Avoid guessing API shapes. If a type isn't in the local `.d.ts` files and the MCP has no result, say so rather than inferring.
- When referencing a type or method found locally, include the file path and line number so the user can navigate to it directly.

Step 2: Configure the MCP server​

Run the following command in your terminal to register the Overwolf docs MCP server with Claude Code:

claude mcp add --transport http ow-docs-mcp https://V9EMDT18EK.algolia.net/mcp/1/cuI6UtBzTwKOL6E0Hvp-hw/mcp