diff --git a/docs/openapi-servers/index.mdx b/docs/openapi-servers/index.mdx index 0bee086..1ed5220 100644 --- a/docs/openapi-servers/index.mdx +++ b/docs/openapi-servers/index.mdx @@ -42,40 +42,6 @@ uvicorn main:app --host 0.0.0.0 --reload Now, simply point your OpenAPI-compatible clients or AI agents to your local or publicly deployed URL—no configuration headaches, no complicated transports. -## 📂 Server Examples - -Reference implementations provided in this repository demonstrate common use-cases clearly and simply: - -- **Filesystem Access** _(servers/filesystem)_ - Manage local file operations safely with configurable restrictions. -- **Git Server** _(servers/git)_ - Expose Git repositories for searching, reading, and possibly writing via controlled API endpoints. -- **WIP: Database Server** _(servers/database)_ - Query and inspect database schemas across common DB engines like PostgreSQL, MySQL, and SQLite. -- **Memory & Knowledge Graph** _(servers/memory)_ - Persistent memory management and semantic knowledge querying using popular and reliable storage techniques. -- **WIP: Web Search & Fetch** _(servers/web-search)_ - Retrieve and convert web-based content securely into structured API results usable by LLMs. - -(More examples and reference implementations will be actively developed and continually updated.) - -## 🔌 Bridge to MCP (Optional) - -For the easiest way to expose your MCP tools as OpenAPI-compatible APIs, we recommend using [mcpo](https://github.com/open-webui/mcpo). This enables tool providers who initially implemented MCP servers to expose them effortlessly as standard OpenAPI-compatible APIs, ensuring existing MCP servers and resources remain accessible without additional hassle. - -**Quick Usage:** -```bash -uvx mcpo --port 8000 -- uvx mcp-server-time --local-timezone=America/New_York -``` - -Alternatively, we also provide a simple Python-based proxy server: - -**Example:** -```bash -cd servers/mcp-proxy -pip install -r requirements.txt -python main.py --host 0.0.0.0 --port 8000 -- uvx mcp-server-time --local-timezone=America/New_York -``` - -Both methods help bridge existing MCP servers with OpenAPI clients, removing transport and security complexities during integration or migration. - - - ## 🌱 Open WebUI Community - For general discussions, technical exchange, and announcements, visit our [Community Discussions](https://github.com/open-webui/openapi-servers/discussions) page. diff --git a/docs/openapi-servers/mcp.mdx b/docs/openapi-servers/mcp.mdx index 5d0bae3..f156dbb 100644 --- a/docs/openapi-servers/mcp.mdx +++ b/docs/openapi-servers/mcp.mdx @@ -102,6 +102,8 @@ That's it! You're now running the MCP-to-OpenAPI Proxy locally and exposing the Feel free to replace `uvx mcp-server-time --local-timezone=America/New_York` with your preferred MCP Server command from other available MCP implementations found in the official repository. +🤝 **To integrate with Open WebUI after launching the server, check our [docs](https://docs.openwebui.com/openapi-servers/open-webui/).** + ### 🚀 Accessing the Generated APIs As soon as it starts, the MCP Proxy (`mcpo`) automatically: