Swarms API MCP Server

🚀 蜂群 API 文檔

蜂群 API 提供了便捷的方式來調用相關服務，通過簡單的代碼即可實現蜂群任務的執行。下面將詳細介紹如何使用該 API 以及相關的注意事項。

🚀 快速開始

您可以使用以下代碼調用蜂群 API：

import os
from typing import Any, Dict, List, Optional
import requests

# 環境變量獲取 API_KEY
API_KEY = os.getenv("SWARMS_API_KEY")

# 創建一個示例負載
payload = {
    "agents": [
        {
            "agent_name": "Example Agent 1",
            "description": "This is a test agent.",
            "system_prompt": "You are an example agent.",
            "model_name": "gpt-4o",
            "role": "worker",
            "max_loops": 1,
            "temperature": 0.5
        }
    ],
    "max_loops": 1,
    "swarm_type": "ConcurrentWorkflow",
    "task": "這是一個測試任務。",
    "return_history": True
}

# 發送 POST 請求
response = requests.post(
    "https://swarms-api-285321057562.us-east1.run.app/v1/swarm/completions",
    headers={"x-api-key": API_KEY, "Content-Type": "application/json"},
    json=payload
)

# 打印響應內容
print(response.json())

💻 使用示例

基礎用法

import os
from typing import Any, Dict, List, Optional
import requests

# 環境變量獲取 API_KEY
API_KEY = os.getenv("SWARMS_API_KEY")

# 創建一個示例負載
payload = {
    "agents": [
        {
            "agent_name": "Example Agent 1",
            "description": "This is a test agent.",
            "system_prompt": "You are an example agent.",
            "model_name": "gpt-4o",
            "role": "worker",
            "max_loops": 1,
            "temperature": 0.5
        }
    ],
    "max_loops": 1,
    "swarm_type": "ConcurrentWorkflow",
    "task": "這是一個測試任務。",
    "return_history": True
}

# 發送 POST 請求
response = requests.post(
    "https://swarms-api-285321057562.us-east1.run.app/v1/swarm/completions",
    headers={"x-api-key": API_KEY, "Content-Type": "application/json"},
    json=payload
)

# 打印響應內容
print(response.json())

高級用法

以下是完整的代碼示例，包含了更多功能：

import os
from datetime import datetime
from typing import Any, Dict, List, Optional

import requests
import httpx
from fastmcp import FastMCP
from pydantic import BaseModel, Field
from swarms import SwarmType
from dotenv import load_dotenv

load_dotenv()

BASE_URL = "https://swarms-api-285321057562.us-east1.run.app"

# 創建一個 MCP 服務器
mcp = FastMCP("swarms-api")

# 添加一個額外工具
@mcp.tool(name="swarm_completion", description="運行蜂群完成任務。")
def swarm_completion(swarm: SwarmSpec) -> Dict[str, Any]:
    api_key = os.getenv("SWARMS_API_KEY")
    headers = {"x-api-key": api_key, "Content-Type": "application/json"}

    payload = swarm.model_dump()

    response = requests.post(f"{BASE_URL}/v1/swarm/completions", json=payload, headers=headers)
    
    return response.json()

@mcp.tool(name="swarms_available", description="獲取可用蜂群列表。")
async def swarms_available() -> Any:
    """
    獲取可用蜂群的列表。
    """
    headers = {"Content-Type": "application/json"}

    async with httpx.AsyncClient() as client:
        response = await client.get(f"{BASE_URL}/v1/models/available", headers=headers)
        response.raise_for_status()  # 對於不良響應進行處理
        return response.json()

if __name__ == "__main__":
    mcp.run(transport="sse")

📚 詳細文檔

費用說明

API 使用費用基於以下因素：

1. 使用的代理數量
2. 輸入/輸出令牌數
3. 模型選擇
4. 時間段（高峰期有折扣）

如需瞭解詳細定價信息，請訪問 API 價格頁面。

錯誤處理

其他信息

如需瞭解更多信息，請參考 官方文檔。