This repository provides reference implementations for OpenAPI Tool Servers, enabling secure integration of external tools and data sources into LLM agents and workflows. It targets developers seeking to leverage the established OpenAPI specification for seamless API communication, reducing complexity and vendor lock-in.

How It Works

The project utilizes the OpenAPI specification as a universal protocol for defining and interacting with tool servers. This approach avoids proprietary formats, allowing developers to build or integrate servers using familiar RESTful API principles and existing tooling. Reference implementations are provided in Python using FastAPI, demonstrating how to expose functionalities like filesystem access, Git operations, and weather data through standardized API endpoints.

Quick Start & Requirements

• Install dependencies for a specific server (e.g., filesystem):

  git clone https://github.com/open-webui/openapi-servers
  cd openapi-servers
  cd servers/filesystem
  pip install -r requirements.txt
  uvicorn main:app --host 0.0.0.0 --reload
  

• Alternatively, use Docker:

  cd servers/filesystem
  docker compose up
  

• Prerequisites: Python, pip, uvicorn. Docker Compose for Docker deployment.

Highlighted Details

• Provides reference implementations for common use cases: Filesystem Access, Git Server, Memory & Knowledge Graph, Weather Server, Get User Info Server.
• Work-in-progress (WIP) implementations for Web Search & Fetch and Database Server are under active development.
• Includes optional bridging solutions (mcpo, openapi-mcp-server, mcp-openapi-server, mcp-openapi-proxy, fastapi_mcp) for interoperability with MCP (Meta Communication Protocol) tools.

Maintenance & Community

• Encourages community contributions for new server examples.
• Community discussions are hosted on a dedicated page. Issues can be opened for feedback and ideas.

Licensing & Compatibility

• Licensed under the MIT License.
• Compatible with commercial use and closed-source linking due to its permissive MIT license.

Limitations & Caveats

• Some server implementations are marked as Work-in-Progress (WIP), indicating ongoing development and potential for changes.