Nuxt UI MCP服务器
该项目为Nuxt UI实现了一个模型上下文协议(MCP)服务器,通过标准化的API公开Nuxt UI文档和资源。它使用TypeScript和Express构建,并利用@modelcontextprotocol/sdk。
目录
- 目录 - 特性 - 先决条件 - 安装 - 1.克隆存储库: - 2.安装依赖项: - 运行服务器 - 构建 - 开始(前景) - 开始(背景为PM2) - 停止(背景/PM2) - 删除PM2进程 - 查看PM2日志 - 发展模式 - 环境变量 - 测试 - 贡献 - 许可证
特性
- 通过MCP端点提供Nuxt UI文档和资源
- 基于Express的HTTP服务器
- 支持通过MCP进行基于会话的流式传输
先决条件
- Node.js v18或更高版本
- npm v9或更高版本
安装
1.克隆存储库:
git clone
cd nuxt-ui-mcp2.安装依赖项:
npm install运行服务器
构建
首先,编译TypeScript源代码:
npm run build开始(前景)
npm start开始(背景为PM2)
npm run start:bg停止(背景/PM2)
npm run stop:bg删除PM2进程
npm run delete:bg查看PM2日志
npm run logs:bg发展模式
同时运行服务器和MCP检查器:
npm run dev服务器将在指定的端口上侦听 DEFAULT_PORT 环境变量,或 3000 如果没有设置。
环境变量
创建一个 .env 如果需要覆盖默认值,请将文件放在项目根目录中。例子:
DEFAULT_PORT=3000测试
目前有 没有自动测试 或此项目的测试脚本。如果您想贡献测试,请参阅 贡献 部分。
贡献
- 分叉此存储库,并为您的功能或修复创建一个新分支。
- 确保你有 和 安装。
- 跑
npm install安装依赖项。 - 使用
npm run build在提交PR之前编译TypeScript。 - 遵循现有的代码风格和TypeScript的严格性(参见
tsconfig.json). - 如果添加功能或修复错误,请在PR描述中记录您的更改。
许可证
麻省理工学院
