README
🚀 LMStudio - MCP 项目文档
LMStudio - MCP 搭建了一座桥梁,将具备 MCP 功能的 Claude 与您本地运行的 LM Studio 实例相连接。借助这座桥梁,Claude 能够检查 LM Studio API 的健康状态、列出可用模型、获取当前加载的模型,还能使用您的本地模型生成完成词,让您可以将 Claude 的功能与自己的私有模型结合使用。
🚀 快速开始
LMStudio - MCP 能让您将 Claude 与本地 LM Studio 实例相连,实现多种功能。使用前,请确保满足先决条件,并完成安装和配置。
✨ 主要特性
- 检查 LM Studio API 的健康状态。
- 列出可用模型。
- 获取当前加载的模型。
- 使用本地模型生成完成词,结合 Claude 功能与私有模型。
📦 安装指南
先决条件
- Python 3.7 或更高版本。
- 已安装并运行 LM Studio(https://lmstudio.ai/)。
- 模型已加载到 LM Studio。
- Claude 带有 MCP 访问权限。
- 所需的 Python 包(参见安装步骤)。
安装步骤
- 克隆此仓库:
git clone https://github.com/infinitimeless/LMStudio-MCP.git
cd LMStudio-MCP
- 安装所需的包:
pip install requests "mcp[cli]" openai
📚 详细文档
MCP 配置
为了让 Claude 连接到此桥梁,您需要正确配置 MCP 设置。您可以选择:
- 直接从 GitHub 使用:
{
"lmstudio-mcp": {
"command": "uvx",
"args": [
"https://github.com/infinitimeless/LMStudio-MCP"
]
}
}
- 使用本地安装:
{
"lmstudio-mcp": {
"command": "/bin/bash",
"args": [
"-c",
"cd /path/to/LMStudio-MCP && source venv/bin/activate && python lmstudio_bridge.py"
]
}
}
有关 MCP 配置的详细说明,请参见 MCP_CONFIGURATION.md。
使用方法
- 启动您的 LM Studio 应用程序并确保其在默认端口 1234 上运行。
- 在 LM Studio 中加载一个模型。
- 如果是本地运行(不使用
uvx),启动 LMStudio - MCP 服务器:
python lmstudio_bridge.py
- 在 Claude 中,选择 "lmstudio - mcp" 连接到 MCP 服务器。
可用功能
桥梁提供了以下功能:
health_check():验证 LM Studio API 是否可访问。list_models():获取 LM Studio 中所有可用模型的列表。get_current_model():识别当前加载的模型。chat_completion(prompt, system_prompt, temperature, max_tokens):从您的本地模型生成文本。
🔧 技术细节
已知限制
- 部分模型(例如 phi - 3.5 - mini - instruct_uncensored)可能存在兼容性问题。
- 桥梁目前仅使用 LM Studio 的 OpenAI 兼容 API 端点。
- 模型的响应将受限于您加载的本地模型的能力。
故障排除
API 连接问题
如果 Claude 报告 404 错误,无法连接到 LM Studio:
- 确保 LM Studio 正在运行并且已加载模型。
- 检查 LM Studio 的服务器是否在端口 1234 上运行。
- 验证防火墙是否未阻止连接。
- 如果问题仍然存在,尝试在 API URL 中使用 "127.0.0.1" 而不是 "localhost"。
模型兼容性
如果某些模型无法正常工作:
- 确保您使用的模型与 LM Studio 兼容。
- 查看 MCP_CONFIGURATION.md 了解更多信息。
有关更多故障排除步骤,请参见 TROUBLESHOOTING.md。
📄 许可证
文档中未提及许可证相关信息。
常用提示信息
⚠️ 重要提示
本项目仍处于开发阶段,可能存在不稳定或功能不完善的情况。
💡 使用建议
使用前请仔细阅读相关文档并备份重要数据。
Scan to contact