Hippycampus

🚀 骑士海马

骑士海马是一个基于LangChain的CLI和MCP服务器，支持动态加载OpenAPI规范并与Langflow集成，为用户提供便捷的操作和强大的功能。

🚀 快速开始

在开始使用骑士海马之前，你需要满足以下先决条件，并按照安装步骤进行操作。

✅ 先决条件

• Python 3.12.9
• UV包管理器
• Google AI Studio API密钥
• Langflow（用于可视化工作流创建）

📦 安装

# 如果尚未安装UV，请先安装
curl -LsSf https://astral.sh/uv/install.sh | sh

# 创建并激活虚拟环境
uv venv
source .venv/bin/activate  # 在Windows上使用：.venv\Scripts\activate

# 安装hippycampus及其依赖项
uv pip install -e .

# 安装langflow
uv pip install langflow

⚙️ 配置

Google AI Studio API密钥

1. 访问Google AI Studio
2. 点击右上角的“创建API密钥”
3. 复制生成的密钥并设置为环境变量：

export GOOGLE_API_KEY='your-api-key-here'

▶️ 运行应用程序

CLI模式（无MCP服务器）

uv run hippycampus-cli

MCP服务器模式（SSE）

uv run hippycampus-server --transport sse --port 8000

Langflow服务器

确保MCP服务器正在运行，再启动Langflow。

1. 设置组件路径环境变量：

# 获取当前工作目录
pwd
# 使用输出设置组件路径
export LANGFLOW_COMPONENTS_PATH="/output/from/pwd/langflow/components"

2. 启动Langflow服务器（添加--dev进入开发模式）：

uv run langflow run

3. 打开浏览器，导航到 http://localhost:7860

使用自定义组件在Langflow中

1. 在Langflow UI中定位自定义组件：
   • OpenApi Service：用于加载OpenAPI规范
   • Hippycampus MCP服务器：用于通过SSE连接到MCP服务器
2. 配置组件：
   • OpenApi Service：使用测试版本https://raw.githubusercontent.com/APIs-guru/unofficial_openapi_specs/master/xkcd.com/1.0.0/openapi.yaml
   • MCP Server：使用http://localhost:8000/sse

参见屏幕录像演示。 屏幕录像演示

⚠️ 重要提示 官方的XKCD Swagger文件包含一个错误，将comic_id字段指定为数字而不是整数，在测试文件夹中有一个修复版本。

❓ 故障排除

• 认证错误：检查GOOGLE_API_KEY是否正确设置
• Langflow中缺少组件：确认LANGFLOW_COMPONENTS_PATH指向正确的目录
• 连接问题：确保MCP服务器正在运行后再通过Langflow连接
• 如果组件未在Langflow中显示，请尝试重新启动Langflow服务器
• 在运行MCP/Langflow之前，使用cli调试openapi_builder/spec_parser和代理交互问题

📄 许可证

本项目采用MIT License。

版权 (c) 2024 Ray Cromwell

准许任何人免费获取本软件及关联文档文件（“软件”），不受限制地处理、复制、修改、合并、分发、分发、 sublicense以及出售该软件的副本，同时允许向获得该软件的人提供处理该软件的权利。

上述版权声明和本许可声明应包含在所有副本或实质性部分中。

软件按“原样”提供，不做任何明示或暗示的保证，包括但不限于对适销性、特定用途的适用性和不侵权的保证。无论是在合同行为、侵权行为或其他行为中，作者或版权持有者均不对因使用本软件而产生的任何声明、损害或其它责任负责。

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.