Stablemcp

🚀 StableMCP Project Documentation

StableMCP is an open - source tool for image generation and processing tasks. It supports multiple models and can be invoked through a simple API.

🚀 Quick Start

Get started with StableMCP by following the installation and usage instructions below.

✨ Features

• Supports multiple models.
• Can be easily invoked via a simple API.

📦 Installation

Install using Docker

To run StableMCP with Docker, execute the following commands:

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

Install using binary files

On a Linux system, you can download the pre - compiled binary file:

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

📚 Documentation

Configuration File

StableMCP can set different parameters through a configuration file. The default configuration file is located at config.yaml, with the following content:

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

Usage Instructions

Generate Images

You can use StableMCP to generate images with the following command:

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 Initialization Request

To initialize the MCP service, send the following request:

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

Development Guide

Project Structure

The project structure of StableMCP is as follows:

stablemcp/
├── cmd/          # Command-line tool entry
│   └── main.go
├── internal/     # Core function packages
│   ├── version/    # Version information management
│   │   └── version.go
│   └── config/     # Configuration file parsing
│       └── config.go
├── models/        # Model file storage location
└── assets/         # Other resource files

Initialize the MCP Service

Here is an example of initializing the MCP service in code:

package main

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

func main() {
    // Get version information
    version := version.GetVersion()
    // Start the service
    startServer(version)
}

Version Management

StableMCP uses semantic versioning. The current version is v0.1.1.

Tagging

To create a new tag, execute the following command:

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

Continuous Integration and Delivery (CI/CD)

The continuous integration process for StableMCP is as follows:

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

Contribution Guide

Submit Code

To submit code to the repository, follow these steps:

git clone https://github.com/mkm29/stablemcp.git
cd stablemcp
git checkout main
# Add files
git add .
# Commit changes
git commit -m "Add new feature"
git push origin main

Development Environment Setup

To create a development environment for StableMCP, follow these steps:

git clone https://github.com/mkm29/stablemcp.git
cd stablemcp
make dev_setup
# Start the service
./stablemcp serve --dev

📄 License

StableMCP is licensed under the MIT License. The full license text is as follows:

 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.

Contributors

• Author: Your Name your.email@example.com
• Maintainer: Maintainer Name maintain.email@example.com

Contact Information

If you have any questions about StableMCP, please contact us via the following methods:

• Email: contact@stablemcp.org
• GitHub: https://github.com/mkm29/stablemcp