Spiral MCP 服务器

这是一个使用 Python 实现的 Spiral API 的模型上下文协议 (MCP) 服务器。它为与 Spiral 的语言模型交互提供了一个标准化的接口。

安装

mcp install src/server.py --name "spiral-writing-tool" --with pydantic --with requests --with beautifulsoup4 --with httpx

设置

1. 创建并激活一个虚拟环境：

python3 -m venv venv
source venv/bin/activate  # 在 Windows 上，使用 `venv\Scripts\activate`

2. 安装依赖：

uv pip install -r requirements.txt

3. 在根目录下创建一个 .env 文件，并添加您的 Spiral API 密钥：

SPIRAL_API_KEY=your_api_key_here

您可以从 https://app.spiral.computer/api 获取您的 API 密钥。

运行服务器

启动服务器：

python src/server.py

服务器默认运行在 3000 端口。您可以通过设置 PORT 环境变量来更改此端口。

测试工具

要直接测试 MCP 工具：

python src/test_tools.py

这将运行所有可用工具的测试，以验证其功能。

MCP 工具

该服务器实现了四个强大的 MCP 工具：

list_models

列出所有可用的 Spiral 模型及其功能和元数据。

示例响应：

{
    "models": [
        {
            "id": "model-id",
            "name": "model-name",
            "description": "Model description",
            "input_format": "text",
            "output_format": "text",
            "capabilities": {
                "completion": true
            }
        }
    ]
}

generate

使用指定的 Spiral 模型生成文本。

参数：

• model: 要使用的 Spiral 模型的 ID 或 slug
• prompt: 用于生成的输入文本

示例：

{
    "model": "model_id_or_slug",
    "prompt": "Your input text here"
}

generate_from_file

使用 Spiral 模型和来自文件的输入生成文本。 这对于处理较大的文档或保持一致的格式非常有用。

参数：

• model: 要使用的 Spiral 模型的 ID 或 slug
• file_path: 要用作输入的文件的路径

示例：

{
    "model": "model_id_or_slug",
    "file_path": "path/to/your/input.txt"
}

generate_from_url

使用 Spiral 模型和来自 URL 的输入生成文本。 此工具可以自动从网页中提取文章内容。

参数：

• model: 要使用的 Spiral 模型的 ID 或 slug
• url: 要从中获取内容的 URL
• extract_article: 是否提取文章内容或使用完整的 HTML（默认值：true）

示例：

{
    "model": "model_id_or_slug",
    "url": "https://example.com/article",
    "extract_article": true
}

错误处理

服务器处理各种错误情况，包括：

• 无效的 API 密钥
• 找不到模型
• 输入太长
• 超过速率限制
• URL 获取失败
• 文件读取错误
• 服务器错误
• 请求超时

每个错误都会返回清晰的错误消息，以帮助诊断问题。

环境变量

• SPIRAL_API_KEY: 您的 Spiral API 密钥（必需）
• PORT: 服务器端口（可选，默认为 3000）
• TIMEOUT: 请求超时时间（秒）（可选，默认为 30）

特性

• 强大的错误处理: 针对所有操作的全面错误处理和日志记录
• 文章提取: 从网页智能提取文章内容
• 灵活的输入源: 支持文本、文件和 URL 作为输入
• 异步操作: 所有操作都是异步的，以获得更好的性能
• 类型安全: 对所有参数进行完整的 Pydantic 类型验证
• 日志记录: 用于故障排除的详细调试日志