mirror of
				https://github.com/open-webui/mcpo
				synced 2025-06-26 18:26:58 +00:00 
			
		
		
		
	doc: readme
This commit is contained in:
		
							parent
							
								
									4403c3d9a9
								
							
						
					
					
						commit
						cedd15796b
					
				
							
								
								
									
										21
									
								
								LICENSE
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										21
									
								
								LICENSE
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,21 @@ | ||||
| MIT License | ||||
| 
 | ||||
| Copyright (c) 2025 Timothy Jaeryang Baek | ||||
| 
 | ||||
| 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. | ||||
							
								
								
									
										34
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										34
									
								
								README.md
									
									
									
									
									
								
							| @ -0,0 +1,34 @@ | ||||
| # ⚡️ mcpo | ||||
| 
 | ||||
| Expose any MCP tool as an OpenAPI-compatible HTTP server—instantly. | ||||
| 
 | ||||
| mcpo is a dead-simple proxy that takes an MCP command and makes it accessible via standard RESTful OpenAPI, so your tools "just work" with LLM agents and apps expecting OpenAPI servers. | ||||
| 
 | ||||
| No custom protocol. No glue code. No hassle. | ||||
| 
 | ||||
| ## 🚀 Quick Usage | ||||
| 
 | ||||
| We recommend using uv for lightning-fast startup and zero config. | ||||
| 
 | ||||
| ```bash | ||||
| uvx mcpo --port 8000 -- uvx mcp-server-time --local-timezone=America/New_York | ||||
| ``` | ||||
| 
 | ||||
| Or, if you’re using Python: | ||||
| 
 | ||||
| ```bash | ||||
| pip install mcpo | ||||
| mcpo --host 0.0.0.0 --port 8000 -- uvx mcp-server-time --local-timezone=America/New_York | ||||
| ``` | ||||
| 
 | ||||
| That’s it. Your MCP tool is now available at http://localhost:8000 with a generated OpenAPI schema. | ||||
| 
 | ||||
| ## 🔧 Requirements | ||||
| 
 | ||||
| - Python 3.8+ | ||||
| - MCP tool installed (e.g. mcp-server-time) | ||||
| - uv (optional, but highly recommended for performance + packaging) | ||||
| 
 | ||||
| ## 🪪 License | ||||
| 
 | ||||
| MIT | ||||
| @ -1,7 +1,10 @@ | ||||
| [project] | ||||
| name = "mcpo" | ||||
| version = "0.0.3" | ||||
| version = "0.0.4" | ||||
| description = "A simple, secure MCP-to-OpenAPI proxy server" | ||||
| authors = [ | ||||
|     { name = "Timothy Jaeryang Baek", email = "tim@openwebui.com" } | ||||
| ] | ||||
| readme = "README.md" | ||||
| requires-python = ">=3.11" | ||||
| dependencies = [ | ||||
|  | ||||
		Loading…
	
		Reference in New Issue
	
	Block a user