Skip to content

umijs/umi-mcp

Repository files navigation

umi-mcp

MCP collection for the umi framework.

Features

  • Support umi, @umijs/max and the Bigfish framework.

Tools

  • umi-help: Get help description for umi.
  • umi-config-list: List all config of the umi project.
  • umi-config-get: Get the value of a config of the umi project.
  • umi-config-set: Set the value of a config of the umi project.
  • umi-config-remove: Remove a config of the umi project.
  • umi-build: Build the umi project. (Run build and return the output, bundle size, etc.)
  • umi-generate-page: Generate a page of the umi project.
  • umi-generate-xxx, More generate tools...
  • umi-lint, Run the linting of the umi project.
  • umi-plugin-list, List all plugins of the umi project.
  • umi-setup, Setup the umi project and generate the tmp files in the .umi directory.
  • umi-deadcode, Find the dead code of the umi project.
  • umi-version, Show the version of the umi project.
  • umi-route-list, List all routes of the umi project. (Based on the appData under .umi directory)
  • umi-appdata-list, List detailed app data of the umi project. (Based on the appData under .umi directory)
  • umi-changelog, Show the changelog of the umi and @umijs/max.

Usage

$ npx -y umi-mcp <root>

Usage with Cursor

add the following to your <root>/.cursor/mcp.json:

NPX

{
  "mcpServers": {
    "umi-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "umi-mcp",
        "<root>"
      ]
    }
  }
}

CONTRIBUTING

See CONTRIBUTING.md.

LICENSE

MIT