Fu-Jie_openwebui-extensions/plugins/pipes/github-copilot-sdk/README.md

GitHub Copilot SDK Pipe for OpenWebUI

Author: Fu-Jie | Version: 0.3.0 | Project: Awesome OpenWebUI | License: MIT

This is an advanced Pipe function for OpenWebUI that allows you to use GitHub Copilot models (such as gpt-5, gpt-5-mini, claude-sonnet-4.5) directly within OpenWebUI. It is built upon the official GitHub Copilot SDK for Python, providing a native integration experience.

🚀 What's New (v0.3.0) - The Power of "Unified Ecosystem"

• 🔌 Zero-Config Tool Bridge: Automatically transforms your existing OpenWebUI Functions (Tools) into Copilot-compatible tools. Copilot now has total access to your entire WebUI toolset!
• 🔗 Dynamic MCP Discovery: Seamlessly connects to MCP servers defined in Admin Settings -> Connections. No configuration files required—it just works.
• ⚡ High-Performance Async Engine: Background CLI updates and optimized event-driven streaming ensure lightning-fast responses without UI lag.
• 🛡️ Robust Interoperability: Advanced sanitization and dynamic Pydantic model generation ensure smooth integration even with complex third-party tools.

✨ Key Capabilities

• 🌉 The Ultimate Bridge: The first and only plugin that creates a seamless bridge between OpenWebUI Tools and GitHub Copilot SDK.
• 🚀 Official & Native: Built directly on the official Python SDK, providing the most stable and authentic Copilot experience.
• 🌊 Advanced Streaming (Thought Process): Supports full model reasoning/thinking display with typewriter effects.
• 🖼️ Intelligent Multimodal: Full support for images and attachments, enabling Copilot to "see" your workspace.
• 🛠️ Effortless Setup: Automatic CLI detection, version enforcement, and dependency management.
• 🔑 Dual-Layer Security: Supports secure OAuth flow for Chat and standard PAT for extended MCP capabilities.

Installation & Configuration

1) Import Function

1. Open OpenWebUI.
2. Go to Workspace -> Functions.
3. Click + (Create Function).
4. Paste the content of github_copilot_sdk.py (or github_copilot_sdk_cn.py for Chinese) completely.
5. Save.

2) Configure Valves (Settings)

Find "GitHub Copilot" in the function list and click the ⚙️ (Valves) icon to configure:

Parameter	Description	Default
GH_TOKEN	(Required) GitHub Access Token (PAT or OAuth Token). Access to Chat.	-
DEBUG	Whether to enable debug logs (output to browser console).	False
LOG_LEVEL	Copilot CLI log level: none, error, warning, info, debug, all.	error
SHOW_THINKING	Show model reasoning/thinking process (requires streaming + model support).	True
COPILOT_CLI_VERSION	Specific Copilot CLI version to install/enforce.	0.0.405
EXCLUDE_KEYWORDS	Exclude models containing these keywords (comma separated).	-
WORKSPACE_DIR	Restricted workspace directory for file operations.	-
INFINITE_SESSION	Enable Infinite Sessions (automatic context compaction).	True
COMPACTION_THRESHOLD	Background compaction threshold (0.0-1.0).	0.8
BUFFER_THRESHOLD	Buffer exhaustion threshold (0.0-1.0).	0.95
TIMEOUT	Timeout for each stream chunk (seconds).	300
CUSTOM_ENV_VARS	Custom environment variables (JSON format).	-
REASONING_EFFORT	Reasoning effort level: low, medium, high. xhigh is supported for some models.	medium
ENFORCE_FORMATTING	Add formatting instructions to system prompt for better readability.	True
ENABLE_MCP_SERVER	Enable Direct MCP Client connection (Recommended).	True
ENABLE_OPENWEBUI_TOOLS	Enable OpenWebUI Tools (includes defined and server tools).	True

User Valves (per-user overrides)

These optional settings can be set per user (overrides global Valves):

Parameter	Description	Default
GH_TOKEN	Personal GitHub Token (overrides global setting).	-
REASONING_EFFORT	Reasoning effort level (low/medium/high/xhigh).	-
DEBUG	Enable technical debug logs.	False
SHOW_THINKING	Show model reasoning/thinking process.	True
ENABLE_OPENWEBUI_TOOLS	Enable OpenWebUI Tools (overrides global).	True
ENABLE_MCP_SERVER	Enable MCP server loading (overrides global).	True
ENFORCE_FORMATTING	Enforce formatting guidelines (overrides global).	True

⭐ Support

If this plugin has been useful, a star on Awesome OpenWebUI is a big motivation for me. Thank you for the support.

Get Token

To use GitHub Copilot, you need a GitHub Personal Access Token (PAT) with appropriate permissions.

Steps to generate your token:

1. Visit GitHub Token Settings.
2. Click Generate new token (fine-grained).
3. Repository access: Select Public Repositories (simplest) or All repositories.
4. Permissions:
   • If you chose All repositories, you must click Account permissions.
   • Find Copilot Requests, and select Access.
5. Generate and copy the Token.

📋 Dependencies

This Pipe will automatically attempt to install the following dependencies:

• github-copilot-sdk (Python package)
• github-copilot-cli (Binary file, installed via official script)

Troubleshooting ❓

• Images not recognized:
  • Ensure MODEL_ID is a model that supports multimodal input.
• Thinking not shown:
  • Ensure streaming is enabled and the selected model supports reasoning output.

Changelog

See the full history on GitHub: Awesome OpenWebUI