Developer docs
Offer your plugin's features to AI assistants, or help build XIV MCP itself.
There are two ways to build on XIV MCP.
Add AI tools to your plugin
Register tools assistants can call, ask the player at risky moments, and start background jobs, over Dalamud IPC.
Contribute to XIV MCP
Build, test and change XIV MCP itself: its architecture, workflow and this site.
The plugin API in one minute
Your Dalamud plugin can offer tools to AI assistants through XIV MCP. You do not need a server or a reference to XIV MCP, and your plugin keeps working without it.
// XivMcpClient.cs comes from examples/, copied into your plugin.
// FollowTarget and StartFollowing are your plugin's own code.
mcp = new XivMcpClient(pluginInterface);
mcp.AddTool(
new("myplugin_status", "Whom My Plugin is following right now.")
{
ReadOnly = true,
},
args => new { following = FollowTarget?.Name });
mcp.AddTool(
new("myplugin_follow", "Follows the current target on foot.")
{
Capabilities = [McpCapabilities.MoveCharacter],
},
args => { StartFollowing(); return new { following = true }; });The player decides what your tools may do. They enable your plugin, and choose Allow, Ask or Deny for every capability you declare. XIV MCP checks what each call changed, and suspends plugins whose calls have effects they did not declare.
Start with the Quick start, and read the Guidelines before you publish.