@fui-org/fui-mcp
v1.0.2
Published
MCP server for FUI low-code system - manage projects and modules via AI
Maintainers
Readme
FUI MCP Server
MCP server for FUI low-code system - manage projects and modules via AI.
Quick Start
No installation required! You can run this MCP server directly using npx:
npx @fui-org/fui-mcpConfiguration
1. Claude Desktop
Add this to your %APPDATA%\Claude\claude_desktop_config.json:
{
"mcpServers": {
"fui-mcp": {
"command": "npx",
"args": ["-y", "@fui-org/fui-mcp"],
"env": {
"FUI_API_TOKEN": "YOUR_FUI_API_KEY_HERE"
}
}
}
}2. Cursor
Go to Cursor Settings > Features > MCP Servers > Add New:
- Name:
fui-mcp - Type:
command - Command:
npx -y @fui-org/fui-mcp - Environment Variables:
FUI_API_TOKEN=your_token_from_fui.vn
3. Chrome Extension Integration
To use this MCP server from a Chrome Extension, run it in SSE mode:
npx @fui-org/fui-mcp --sse
# Server listening on http://localhost:3001Or specify a custom port:
npx @fui-org/fui-mcp --sse --port 8080In your Extension (background script):
const eventSource = new EventSource('http://localhost:3001/sse');
eventSource.onmessage = (event) => {
console.log('MCP Message:', JSON.parse(event.data));
};
// Use POST /messages to send requestsPrerequisites
- Node.js (v18 or higher)
- FUI API Token (Get it from fui.vn)
FUI_API_BASEpointing to your FUI API base URL- Include a bundled
src/skills/folder in this MCP package if you want every checkout to copy the full skill set into project workspaces
Local Staging Workspace
This MCP now supports a local staging workflow for patch-based editing.
- Default workspace root:
~/.fui-mcp/workspaces - Override with env:
FUI_MCP_WORKDIR=/your/custom/path
Checked-out modules are materialized as:
<workspaceRoot>/<projectId>/
|-- skills/
| `-- fui-skill/
| |-- SKILL.md
| `-- ...
`-- <moduleId>/
|-- _info.json
|-- module.json
|-- script.js
|-- header.html
|-- body.html
|-- dependencies.json
`-- components/
|-- _components.json
`-- *.vueOn every checkout_module, MCP will also copy the bundled src/skills/ folder into <workspaceRoot>/<projectId>/skills.
If the bundled folder is missing, MCP writes a fallback skills/fui-skill/SKILL.md there so the agent still has project-local guidance.
Recommended flow:
- Optionally call
resolve_targetwith/projectId/moduleId - Call
checkout_module- either with
target: "/projectId/moduleId" - or with
projectId+moduleId
- either with
checkout_moduleautomatically sets the active module target- Read the copied project skills in
<workspaceRoot>/<projectId>/skills/before editing - Optionally call
get_fui_skill_rulesor readlowcode://skill/fuifor a concise MCP-provided summary - Optionally call
sync_staged_moduleto refresh from remotemoduleDircan be omitted when an active target exists
- Let the agent edit local files with patches
- Review/apply changes
- Call
preview_publishand ask the user whether they want to push to FUI - Call
publish_staged_module
moduleDircan be omitted when an active target existsapprovalTokenfrompreview_publishis required
Tools
| Tool | Description |
|------|-------------|
| resolve_target | Resolve /project/module into concrete FUI IDs |
| get_fui_skill_rules | Read the critical FUI skill rules before editing |
| get_active_module | Show the current active staged module target |
| set_active_module | Set the active staged module target explicitly |
| clear_active_module | Clear the current active staged module target |
| list_projects | List available FUI projects |
| list_modules | List modules inside a project |
| create_module | Create a new module (HTML page) in a project |
| get_module | Get module content (HTML, CSS, Vue components) |
| checkout_module | Fetch a module into the local staging workspace by target or explicit IDs |
| sync_staged_module | Refresh a staged local module from remote, optionally using the active target |
| preview_publish | Preview staged local changes, create a publish approval token, and prompt the agent to ask the user before pushing |
| publish_staged_module | Publish a staged local module directory back to FUI using the approval token from preview_publish |
Resources
| URI | Description |
|-----|-------------|
| lowcode://modules/{projectId}/{moduleId} | Read module content |
| lowcode://skill/fui | Read the concise FUI skill rules |
| lowcode://skill/fui/raw | Read the raw bundled FUI skill document when the package includes skills/fui-skill/ |
Prompts
| Prompt | Description |
|--------|-------------|
| generate-vue-component | Generate Vue 2 component template |
