Stablemcp

🚀 安定MCPプロジェクトドキュメント

安定MCP（StableMCP）は、画像生成と処理タスクに使用されるオープンソースツールです。複数のモデルをサポートしており、シンプルなAPIを通じて呼び出すことができます。

🚀 クイックスタート

安定MCPは、画像生成や処理タスクを簡単に行うことができるオープンソースツールです。以下の手順に従って、すぐに始めることができます。

✨ 主な機能

• 複数のモデルをサポートしています。
• シンプルなAPIを通じて呼び出すことができます。
• 設定ファイルを使用して、様々なパラメータを設定できます。

📦 インストール

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