mcp-dalamud
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@mcp-dalamud List all namespaces in the Dalamud API"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
mcp-dalamud
An MCP server that exposes the Dalamud plugin API documentation to AI assistants. Compatible with any MCP-capable client (Claude Desktop, Cursor, Windsurf, VS Code with Copilot, etc.). Useful when writing FFXIV Dalamud plugins — ask your assistant about services, types, and methods without leaving your editor.
Requirements
Node.js 18+
Any MCP-compatible AI assistant
Related MCP server: unreal-api-mcp
Setup
npm install
npm run buildThen register the server with your MCP client. The server communicates over stdio and takes no environment variables.
Claude Desktop (%APPDATA%\Claude\claude_desktop_config.json on Windows, ~/Library/Application Support/Claude/claude_desktop_config.json on macOS):
{
"mcpServers": {
"dalamud-api": {
"command": "/path/to/node",
"args": ["/path/to/mcp-dalamud/dist/index.js"]
}
}
}Cursor / Windsurf / other clients: refer to your client's MCP documentation — the server entry is the same command + args pair above.
Restart your client after editing the config. On first launch the server crawls dalamud.dev/api and writes a local cache to cache/dalamud-api.json (~96 namespaces, ~572 types). Subsequent starts load from disk instantly.
Tools
Tool | Description |
| List all Dalamud API namespaces |
| List all types in a namespace, grouped by kind |
| Full docs for a type — properties, methods, events, declarations |
| Keyword search across all types and summaries; optional |
| Browse all enum types, optionally filtered by namespace or keyword |
| List injectable services from |
| Find event arg types and delegate subscription points across the API |
| Search properties/methods/events across already-loaded types (no network) |
| Full docs for a specific member on a type |
| Cache status: build time, Dalamud version, member coverage |
| Re-crawl dalamud.dev and rebuild the cache |
Example prompts
"What services are available in Dalamud.Plugin.Services?"
"Show me IClientState — what properties does it have?"
"Search for anything related to inventory"
"What enums exist for inventory slot types?"
"How do I subscribe to framework events in Dalamud?"
"How do I register a slash command in Dalamud?"
These work with any MCP-capable assistant that supports tool use.
How it works
Startup: loads the cache from disk, or crawls dalamud.dev if missing/outdated. Also checks the Dalamud GitHub releases in the background — if a new version is detected, the cache rebuilds automatically.
Cache versioning: the cache carries a version field. If the on-disk cache was built by an older version of this server, it is discarded and rebuilt on the next startup.
Lazy member loading: namespace and type indexes are cached upfront. Individual member details (properties, methods, etc.) are fetched on demand the first time get_type is called for a type, then persisted to cache.
Development
npm run dev # TypeScript watch mode
npm test # Run tests (Vitest)
npm run build # Compile to dist/Tests cover search (including kind filter), searchMembers, findType, findNamespace, isEventRelated, and isValidCache — the core pure-function logic. The crawler itself (network I/O) is not unit-tested.
Project structure
src/
index.ts # MCP server, tool handlers
crawler.ts # Crawling, caching, types
search.ts # findType, findNamespace, search, searchMembers, isEventRelated
type-members.ts # groupMembersByKind, MEMBER_KIND_ORDER
__tests__/
crawler.test.ts
search.test.ts
cache/
dalamud-api.json # generated, not committedAvailable Tools
11 toolsfind_eventsA
Find event-related types and delegate subscription points across the Dalamud API. Useful for locating EventArgs classes, event enums, and delegate types used to subscribe to framework events.
Inputs: kind, query.
get_memberB
Get full documentation for a specific member on a Dalamud type. Fetches the type's members if not already loaded.
Inputs: type (required), member (required).
get_namespaceB
List all types (classes, interfaces, enums, etc.) in a specific Dalamud namespace.
Inputs: namespace (required).
get_typeB
Get full documentation for a Dalamud type including all properties, methods, and events.
Inputs: name (required).
healthA
Return cache status: build time, Dalamud version, namespace/type counts, and lazy-member coverage. Use to decide whether to call refresh_cache.
Inputs: no named parameters.
list_enumsA
List all enum types in the Dalamud API, optionally filtered by namespace or keyword. Useful for discovering game-state constants (job IDs, inventory slots, addon names, etc.).
Inputs: limit, query, namespace.
list_namespacesB
List all Dalamud API namespaces available in the documentation.
Inputs: no named parameters.
list_servicesA
List all DI-injectable services from Dalamud.Plugin.Services — the primary namespace for plugin authors. Returns interfaces only by default; pass includeDelegate: true to also show event-delegate types.
Inputs: query, includeDelegate.
refresh_cacheA
Re-crawl dalamud.dev and rebuild the local documentation cache. Use when docs seem outdated.
Inputs: no named parameters.
searchB
Search the Dalamud API documentation by keyword. Returns matching types from all namespaces.
Inputs: query (required), kind, limit.
search_membersA
Search for specific members (properties, methods, fields, events, constructors) across all types that have already been loaded. Fast — no network access required. Gets more useful over time as more types are fetched via get_type.
Inputs: query (required), kind, limit, namespace.
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 targets a distinct resource or action: searching types vs. members, getting type vs. member details, listing namespaces/services/enums/events, and cache management. Boundaries are clear from descriptions despite some specialized list tools. No two tools appear to do the same thing.
Most names follow verb_noun snake_case (search_members, get_member, list_services, etc.), providing a predictable pattern. Minor deviations: 'health' is a noun and 'search' is a bare verb, but the overall convention is consistent.
11 tools is well within the ideal range and each tool serves a specific purpose in the documentation browsing workflow. No tool feels redundant or out of scope.
The surface covers type/member lookup, namespace/enum/service/event discovery, and cache management, which is comprehensive for an API doc browser. A minor gap is that search_members only works on already-loaded types, so a global member search requires first fetching types via get_type; this is workable but not fully seamless.
Maintenance
Related MCP Connectors
Versioned documentation registry and semantic search for AI tools and coding assistants.
Publish your API docs so AI assistants can look up endpoints and call your API correctly.
Tailor Platform for AI assistants: search, list and read the platform documentation.
Provide your AI coding tools with token-efficient access to up-to-date technical documentation for…
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceEnables AI models to seamlessly access and query local markdown technical documentation files, providing automatic documentation context without explicit prompting.5ISC
- AlicenseAqualityBmaintenanceProvides accurate Unreal Engine C++ API documentation to AI agents, preventing hallucinated signatures and incorrect includes.579 PyPI100MIT
- AlicenseNot gradedqualityDmaintenanceProvides AI assistants with access to the complete Godot Engine documentation, enabling developers to get answers about Godot classes, tutorials, and features directly in their chat interface.75MIT
- AlicenseAqualityDmaintenanceExposes Swagger/OpenAPI API documentation to AI models, enabling exploration, search, and interaction with endpoints, schemas, and execution of API calls.1413 npm2MIT