Magic Api Mcp Server
@Dwsy
About Magic Api Mcp Server
Magic-API MCP Server - A Model Context Protocol server for Magic-API development
Basic information
Config
Add this server to your MCP-compatible client using the configuration below.
{
"mcpServers": {
"magic-api-mcp-server": {
"command": "uvx",
"args": [
"magic-api-mcp-server@latest",
"--transport",
"stdio"
],
"timeout": 600,
"env": {
"MAGIC_API_BASE_URL": "http://127.0.0.1:10712",
"MAGIC_API_WS_URL": "ws://127.0.0.1:10712/magic/web/console",
"MAGIC_API_TIMEOUT_SECONDS": "30.0",
"LOG_LEVEL": "INFO"
}
}
}
}Tools
54查询 Magic-Script 编程语言的语法规则和使用示例
强制获取完整的Magic-Script语法规则 - 大模型编写代码前必须调用此工具以确保语法准确性
获取 Magic-Script 的场景示例代码，支持按类型和关键词过滤
获取 Magic-API 官方文档索引和详细内容
获取 Magic-API 开发的最佳实践指南
获取 Magic-API 开发中常见的坑点和注意事项
获取 Magic-API 开发的标准化工作流程和命令示例
获取指定Magic-API内置模块的API文档
获取所有可用的Magic-API内置模块列表
获取Magic-API内置函数库文档
获取Magic-API所有类型的使用示例
在Magic-API知识库中进行全文搜索
获取Magic-API知识库概览信息
获取Magic-API开发实践指南，包括性能优化、安全实践和调试指南
获取 Magic-API 资源树，支持多种过滤和导出格式。
保存资源分组，支持单个分组创建或更新，包含完整的分组配置选项。
保存API接口，支持单个接口创建或更新，包含完整的API配置选项。
复制资源到指定的目标位置。
移动资源到指定的目标位置。
删除资源，支持单个资源删除或批量资源删除。
列出所有资源分组及其基本信息，支持搜索和数量限制。
读取或设置资源的锁定状态，支持读取当前锁定状态、锁定和解锁操作。
获取资源统计信息，包括各类资源数量和分布。
按ID替换指定 Magic-Script 片段并保存接口，支持一次或全局替换。
根据API路径直接获取接口的详细信息，支持模糊匹配。
根据接口ID获取完整的接口详细信息和配置。返回包含method、path和full_path(完整路径)的详细信息。
搜索和过滤 Magic-API 接口端点，支持按方法、路径、名称等条件过滤。返回包含ID、方法、路径、名称等完整信息的端点列表。
调用 Magic-API 接口并返回请求结果，支持各种HTTP方法和参数。可以通过 method+path 或 api_id 方式调用。
查询备份列表，支持时间戳过滤和名称过滤。
根据ID查询特定对象的备份历史记录。
获取指定备份版本的脚本内容。
回滚到指定的备份版本。
执行手动全量备份。
列出所有 Magic-API 可用的类、扩展和函数，支持翻页浏览。
在 Magic-API 类信息中进行增强搜索，支持正则表达式、关键词、多条件过滤。
在 Magic-API 压缩类信息中进行快速搜索。
获取指定 Magic-API 类的详细信息，包括方法和字段。
在所有API脚本中搜索关键词。
恢复断点执行，继续运行调试脚本。
单步执行，跳过当前断点。
调用指定接口并在命中的断点处暂停，便于调试。
执行完整的调试会话，包括断点设置和状态监控。
获取当前调试状态，包括断点信息和连接状态。
列出当前MCP会话感知到的IDE环境、客户端与打开的文件上下文。
检查WebSocket连接状态和配置信息。
调用 Magic-API 接口并返回请求结果，如果指定时间内没有响应则返回提示信息让客户端轮询断点状态。
获取最新的断点调试状态，用于轮询断点执行情况。
从当前断点恢复执行。
步入当前断点（进入函数/方法内部）。
步出当前函数/方法（执行到当前函数结束）。
在指定行号设置断点。
移除指定行号的断点。
列出当前所有断点。
获取Magic-API助手元信息，包括版本、功能列表和配置。
Overview
What is Magic Api Mcp Server?
Magic Api Mcp Server integrates the Model Context Protocol (MCP) with Magic-API, providing AI assistants with a comprehensive toolchain for Magic-API development. It offers script syntax guidance, API resource management, debugging, knowledge search, and backup capabilities, designed for developers using MCP-compatible clients like Claude Desktop or Cursor.
How to use Magic Api Mcp Server?
Install via pip install uv then run uv sync in the project directory. Configure your MCP client with the JSON snippet using uvx magic-api-mcp-server@latest --transport stdio. Set environment variables such as MAGIC_API_BASE_URL and optionally MAGIC_API_TOKEN for authentication. Use the provided prompts (e.g., magic_api_developer_guide) to instruct the AI assistant on tool usage.
Key features of Magic Api Mcp Server
- Full Magic-Script syntax and documentation tools (mandatory before coding)
- API resource CRUD, move, copy, lock/unlock, and backup
- Debugging with breakpoints, WebSocket sessions, and step execution
- Tool composition modes (full, minimal, development, production, etc.)
- Searches across scripts, TODO comments, knowledge base, and Java classes
- Customizable API response success/failure detection
Use cases of Magic Api Mcp Server
- Developing and testing Magic-API scripts with enforced syntax checks
- Managing API resources (create, edit, delete, and backup)
- Debugging API behavior interactively using breakpoints and WebSocket
- Searching knowledge base for best practices and common pitfalls
- Performing batch operations like resource import/export and full backups
FAQ from Magic Api Mcp Server
What is Magic Api Mcp Server used for?
It provides a set of MCP tools that help AI assistants perform Magic-API development tasks—such as writing scripts, managing APIs, debugging, and accessing documentation—through a standardized protocol.
How do I install and configure Magic Api Mcp Server?
Install uv via pip install uv, then run uv sync to install dependencies. Add the configuration JSON to your MCP client (e.g., Claude Desktop or Cursor) with command uvx magic-api-mcp-server@latest and set environment variables like MAGIC_API_BASE_URL.
What tools are available in Magic Api Mcp Server?
The server includes system, documentation, API, resource management, query, debug, search, backup, class method, and prompt tools. Code generation tools are available but disabled by default. Use the --composition flag to select a subset (e.g., documentation_only).
How do I set up authentication for Magic Api Mcp Server?
Set
More Developer Tools MCP servers
nuxt-mcp / vite-plugin-mcp
antfuMCP server helping models to understand your Vite/Nuxt app better.
OpenSumi
opensumiA framework helps you quickly build AI Native IDE products. MCP Client, supports Model Context Protocol (MCP) tools via MCP server.
MCP Unity Editor (Game Engine)
CoderGamesterModel Context Protocol (MCP) plugin to connect with Unity Editor — designed for Cursor, Claude Code, Codex, Windsurf and other IDEs
JetBrains MCP Proxy Server
JetBrainsA model context protocol server to work with JetBrains IDEs: IntelliJ, PyCharm, WebStorm, etc. Also, works with Android Studio
mcp-excalidraw
yctimlinMCP server and Claude Code skill for Excalidraw — programmatic canvas toolkit to create, edit, and export diagrams via AI agents with real-time canvas sync.
Comments