Stablemcp

🚀 稳定MCP项目文档

稳定MCP（StableMCP）是一个开源工具，主要用于图像生成和处理任务。它支持多种模型，并且提供简单的API供用户调用，能帮助用户轻松完成图像相关的操作。

🚀 快速开始

稳定MCP支持多种安装方式，你可以根据自己的需求选择合适的安装方法。

📦 安装指南

使用Docker安装

若要使用Docker运行稳定MCP，可执行以下命令：

docker pull ghcr.io/mkm29/stablemcp:latest
docker run -p 8080:8080 ghcr.io/mkm29/stablemcp:latest

使用二进制文件安装

在Linux系统上，可下载预编译的二进制文件进行安装：

wget https://github.com/mkm29/stablemcp/releases/download/v0.1.1/stablemcp-linux-amd64.tar.gz
tar zxvf stablemcp-linux-amd64.tar.gz
chmod +x stablemcp
./stablemcp serve

📚 详细文档

配置文件

稳定MCP可通过配置文件设置不同参数。默认配置文件位于config.yaml，内容如下：

server:
  port: 8080
  host: localhost

logging:
  level: info
  file: logs/stablemcp.log

models:
  sd-turbo:
    path: models/sd-turbo.ckpt
  sdxl:
    path: models/sdxl.ckpt

使用说明

生成图像

通过以下命令可使用稳定MCP生成图像：

curl -X POST http://localhost:8080/v1/generate \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "a photo of a cat in space",
    "width": 512,
    "height": 512,
    "num_inference_steps": 50
  }'

MCP初始化请求

要初始化MCP服务，可发送以下请求：

curl -X POST http://localhost:8080/mcp \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": "1",
    "method": "initialize",
    "params": {}
  }'

开发指南

项目结构

稳定MCP的项目结构如下：

stablemcp/
├── cmd/          # 命令行工具入口
│   └── main.go
├── internal/     # 核心功能包
│   ├── version/    # 版本信息管理
│   │   └── version.go
│   └── config/     # 配置文件解析
│       └── config.go
├── models/        # 模型文件存储位置
└── assets/         # 其他资源文件

初始化MCP服务

在代码中初始化MCP服务的示例如下：

package main

import (
    "github.com/mkm29/stablemcp/internal/version"
)

func main() {
    // 获取版本信息
    version := version.GetVersion()
    // 启动服务
    startServer(version)
}

版本管理

稳定MCP采用语义化版本控制，当前版本为v0.1.1。

打标签

要打新的标签，可执行以下命令：

git tag -a v$(go run scripts/print_version.go) -m "New release"

持续集成和交付（CI/CD）

稳定MCP的持续集成流程如下：

jobs:
  build-and-test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up Go
        uses: actions/setup-go@v1
          go-version: 1.x.x
      - name: Run tests
        run: make test

贡献指南

提交代码

要提交代码到仓库，可执行以下步骤：

git clone https://github.com/mkm29/stablemcp.git
cd stablemcp
git checkout main
# 添加文件
git add .
# 提交更改
git commit -m "Add new feature"
git push origin main

开发环境搭建

要为稳定MCP创建一个开发环境，可按以下步骤操作：

git clone https://github.com/mkm29/stablemcp.git
cd stablemcp
make dev_setup
# 启动服务
./stablemcp serve --dev

📄 许可证

稳定MCP遵循MIT许可证，完整的许可证内容如下：

 MIT License

 Copyright (c) 2023 Your Name

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

贡献者

• 作者：Your Name your.email@example.com
• 维护人员：Maintainer Name maintain.email@example.com

联系方式

若有关于稳定MCP的任何问题，可通过以下方式联系：

• 邮箱：contact@stablemcp.org
• GitHub：https://github.com/mkm29/stablemcp