使用说明

项目简介

Yourware MCP服务器 (yourware-mcp) 是一款基于 Model Context Protocol (MCP) 构建的服务器应用，旨在简化Web项目（如HTML文件或包含dist/out目录的项目）向 Yourware 平台的部署流程。它通过MCP协议与客户端（如Cursor, Claude等编辑器或LLM应用）通信，提供项目上传和部署功能，让用户能够直接通过集成了MCP客户端的工具，将本地项目发布到Yourware平台进行托管和展示。

主要功能点

API密钥管理：支持创建、存储和验证 Yourware 平台的 API 密钥，确保安全访问。
项目上传：允许用户上传单个文件或整个目录（通常是编译后的项目输出目录，如 'dist' 或 'out'），自动打包成zip格式进行上传。
项目部署：接收上传的项目文件，调用 Yourware 平台 API 完成项目部署，并返回项目访问链接。
MCP协议支持：遵循 MCP 协议规范，通过 JSON-RPC 与客户端交互，提供标准化的工具调用接口。
多种传输协议支持：支持 'stdio' 和 'sse' 传输协议，方便集成到不同的 MCP 客户端环境中。

安装步骤

Yourware MCP服务器可以通过 'uvx' 工具进行安装和运行。'uvx' 是一个用于安装和运行 JavaScript/TypeScript/WASM 模块的通用工具，这里用于运行基于 Python 开发的 Yourware MCP服务器。

确保已安装 'uvx'：如果尚未安装 'uvx'，请根据 uvx文档进行安装。通常可以使用 npm 或 yarn 进行安装：
```
npm install -g uvx
```
或
```
yarn global add uvx
```
安装 Yourware MCP服务器：使用 'uvx' 命令安装 'yourware-mcp' 包。
```
uvx yourware-mcp@latest stdio
```
这个命令会安装最新版本的 'yourware-mcp' 并以 'stdio' 模式启动服务器。

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令和参数才能连接。以下是 Yourware MCP 服务器的典型配置信息，以 JSON 格式提供：

{
  "mcpServers": {
    "yourware-mcp": {
      "command": "uvx",
      "args": ["yourware-mcp@latest", "stdio"],
      "env": {}
    }
  }
}

配置参数说明:

'server name': 'yourware-mcp' (服务器名称，用于在 MCP 客户端中标识)
'command': 'uvx' (启动服务器的命令，这里使用 'uvx' 工具)
'args': '["yourware-mcp@latest", "stdio"]' (传递给 'uvx' 命令的参数：
- '"yourware-mcp@latest"': 指定要运行的 MCP 服务器包及其版本，'latest' 表示最新版本。
- '"stdio"': 指定使用 'stdio' 传输协议，这是与 MCP 客户端通信的方式。)
'env': '{}' (环境变量，默认为空，如有需要可以设置 'YOURWARE_API_KEY' 等环境变量)

MCP客户端配置示例 (以 Cursor 编辑器为例):

在 Cursor 编辑器的设置中，找到 "Features" -> "MCP Servers"，点击 "Add Server" 添加一个新的 MCP 服务器，按照以下信息配置：

Name: 'yourware-mcp' (或自定义名称)
Command: 'uvx yourware-mcp@latest stdio'

基本使用方法

启动 MCP 服务器：按照上述安装步骤和服务器配置，确保 Yourware MCP 服务器已在后台运行。通常在配置 MCP 客户端后，客户端会自动启动服务器。
配置 API 密钥：
- 首次使用或 API 密钥失效时，MCP 客户端可能会提示您创建或配置 API 密钥。
- 按照提示，访问 Yourware 平台创建 API 密钥，并将其提供给 MCP 客户端。
- API 密钥通常会自动存储在本地，路径为 '~/.yourware/credentials.json'。
使用 MCP 客户端工具：
- 在支持 MCP 协议的客户端（如 Cursor, Claude 等）中，可以使用集成的命令或工具调用 Yourware MCP 服务器的功能。
- 例如，在 Cursor 中，您可以让 AI 助手调用 'upload_project' 工具，并指定本地项目路径，即可将项目上传并部署到 Yourware 平台。
- 常用的工具包括：
  - 'check_credentials': 检查 API 密钥是否有效。
  - 'create_api_key': 引导用户创建新的 API 密钥。
  - 'upload_project': 上传本地项目到 Yourware 平台。
访问已部署项目：项目部署成功后，MCP 服务器会返回项目 URL 和 iframe URL，您可以使用这些链接访问您的 Web 项目。

注意: 请确保您已在 Yourware 平台注册账号并登录，以便创建 API 密钥和管理您的项目。

关键词