Hippycampus

🚀 Knight Hippycampus

A CLI and MCP server based on LangChain that supports dynamic loading of OpenAPI specifications and integrates with Langflow.

🚀 Quick Start

✨ Features

• Based on LangChain, supporting dynamic loading of OpenAPI specifications.
• Integrated with Langflow for visual workflow creation.

📦 Installation

Prerequisites

• Python 3.12.9
• UV package manager
• Google AI Studio API key
• Langflow (for visual workflow creation)

# Install UV if not already installed
curl -LsSf https://astral.sh/uv/install.sh | sh

# Create and activate a virtual environment
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install hippycampus and its dependencies
uv pip install -e .

# Install langflow
uv pip install langflow

Configuration

Google AI Studio API Key

1. Visit Google AI Studio.
2. Click "Create API key" in the top right corner.
3. Copy the generated key and set it as an environment variable:

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

💻 Usage Examples

CLI Mode (without MCP server)

uv run hippycampus-cli

MCP Server Mode (SSE)

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

Langflow Server

Ensure the MCP server is running before starting Langflow.

1. Set the component path environment variable:

# Get the current working directory
pwd
# Set the component path using the output
export LANGFLOW_COMPONENTS_PATH="/output/from/pwd/langflow/components"

2. Start the Langflow server (add --dev to enter development mode):

uv run langflow run

3. Open a browser and navigate to http://localhost:7860

Using Custom Components in Langflow

1. Locate custom components in the Langflow UI:

   • OpenApi Service: For loading OpenAPI specifications.
   • Hippycampus MCP server: For connecting to the MCP server via SSE.

2. Configure the components:

   • OpenApi Service: Use the test version https://raw.githubusercontent.com/APIs-guru/unofficial_openapi_specs/master/xkcd.com/1.0.0/openapi.yaml.
   • MCP Server: Use http://localhost:8000/sse.

See the screencast demonstration. Screen Recording Demonstration

⚠️ Important Note

Note that the official XKCD Swagger file contains an error that specifies the comic_id field as a number instead of an integer. There is a fixed version in the test folder.

Troubleshooting

• Authentication error: Check if GOOGLE_API_KEY is set correctly.
• Missing components in Langflow: Confirm that LANGFLOW_COMPONENTS_PATH points to the correct directory.
• Connection issues: Ensure the MCP server is running before connecting via Langflow.
• If components do not appear in Langflow, try restarting the Langflow server.
• Before running MCP/Langflow, use the cli to debug openapi_builder/spec_parser and proxy interaction issues.

📄 License

MIT License

Copyright (c) 2024 Ray Cromwell

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.