Skip to content

README.md

Latest commit

 

History

History
124 lines (82 loc) · 7.91 KB

README.md

File metadata and controls

124 lines (82 loc) · 7.91 KB

GitHub Copilot Agent Pipe for OpenWebUI

By Fu-Jie · v0.13.0 ⭐ Star this repo
followers points top contributions downloads saves views

This is a GitHub Copilot SDK Pipe for OpenWebUI with Agent Team coordination, Session Modes (autopilot/interactive/plan), autonomous Web Search, Context Compaction, and reuse of your OpenWebUI Tools, MCP servers, and Skills.

Important

Essential Companion To let Copilot directly process uploaded files instead of OpenWebUI's default RAG parsing, you must install the GitHub Copilot SDK Files Filter.

Tip

No Subscription Required for BYOK If you are using your own API keys (BYOK mode with OpenAI/Anthropic), you do NOT need a GitHub Copilot subscription. A subscription is only required to access GitHub's official models.

Install with Batch Install Plugins

If you already use Batch Install Plugins from GitHub , you can install or update this plugin with:

Install plugin from Fu-Jie/openwebui-extensions

When the selection dialog opens, search for this plugin, check it, and continue.

Important

If the official OpenWebUI Community version is already installed, remove it first. After that, Batch Install Plugins can keep this plugin updated in future runs.

✨ v0.13.0: Agent Team + Session Mode Now Work End-to-End

  • 🤖 Agent Team (New): Coordinate multiple OpenWebUI custom models as a sub-agent team within one session. Select by tag (AGENT_TEAM_TAG) or model IDs (AGENT_TEAM_MODEL_IDS), assign a leader (AGENT_TEAM_LEADER) — every agent inherits the same tools (OpenWebUI skills + MCP servers) as the base session.
  • 🎯 Active Session Mode Awareness: The Agent now knows which session mode is active (autopilot / interactive / plan) via an injected [Active Session Mode] system prompt directive, aligned with the official Copilot SDK agent-loop docs. Autopilot drives tasks to completion; interactive stops between steps; plan gates execution behind your approval.
  • ⚡ Mode-Aware Workstyle: Each mode now injects its own preamble — autopilot encourages full end-to-end completion, interactive enforces step-by-step pausing, plan requires approval before any action.
  • 🔒 SDK Mode Set Hardened: Both resume and create session paths now call session.rpc.mode.set() with asyncio.wait_for(timeout=5.0) to prevent hangs, with full debug visibility on failure.
  • 🧹 System Prompt Overhaul: Removed hardcoded Copilot CLI tool names and inapplicable conventions; resolved SQL pattern contradiction; SESSION_MODE now resolves globally as user_valve > global valve > autopilot.

Important

If the plugin shows errors after an update, restart your OpenWebUI server. The plugin is cached in memory and old bytecode may cause import errors. Restarting clears the cache and loads the fresh version.

🚀 Quick Start

  1. Install via Batch Install Plugins → select this plugin
  2. Configure a credential: GH_TOKEN (GitHub Copilot) or BYOK_API_KEY (OpenAI/Anthropic)
  3. Start chatting — select this Pipe's model and ask naturally

Companion Files Filter lets Copilot directly process uploaded files instead of OpenWebUI's default RAG parsing. Install from here.

🧭 How to Use

Just describe what you want. No need to mention tools or internal parameters.

What you ask What happens
Fix the failing tests Normal reply
Summarize this Excel file and chart the trend Agent processes the file and generates charts
Create an interactive dashboard RichUI page rendered in chat
Refactor this plugin Agent plans, executes, and tracks TODO automatically

✨ Key Capabilities

Capability What it means for you
🤖 Agentic AI The Agent autonomously plans the path to your goal
👥 Agent Team Coordinate multiple sub-agents within one session — assign a leader, share tools
🔄 Session Mode Choose autopilot (autonomous), interactive (step-by-step confirm), or plan (plan-first)
🛠️ Built-in Tools File system, Git, bash, publish-to-workspace, directory-based skills — all installed in Docker data dir and persist across sessions
🌐 Web Search Triggers searches when your question needs up-to-date info
♾️ Infinite Sessions Weeks-long projects with automatic context compaction
🧩 Tools & MCP Bridge Your OpenWebUI instance's own Tools and MCP servers are automatically available and persist across sessions
🎨 RichUI / Artifacts Interactive dashboards and pages rendered directly in chat
🛡️ Workspace Isolation Each session runs with privacy isolation where possible

🧩 Companion Files Filter

Lets Copilot directly process uploaded files (Excel, CSV, images) instead of OpenWebUI's default RAG parsing.

Install: GitHub Copilot SDK Files Filter

⚙️ Core Configuration (Valves)

Configure credentials (choose one or both):

Valve What to set
GH_TOKEN GitHub Copilot token (see Get Token below)
BYOK_API_KEY OpenAI or Anthropic key
BYOK_TYPE BYOK type: openai or anthropic
BYOK_BASE_URL BYOK API endpoint (required when using BYOK), e.g. https://api.openai.com/v1 (OpenAI) or https://api.anthropic.com (Anthropic). Other providers may differ — check vendor docs.

💡 Both at once: You can configure both GH_TOKEN and BYOK_API_KEY — the model list will show models from both.

Other valves are optional. See the full list on GitHub.

Get Token

  1. Visit github.com/settings/tokens?type=beta
  2. Create a Fine-grained token with Account permissions → Copilot Requests access
  3. Paste the token into the GH_TOKEN field

⭐ Support

If this plugin has been useful, a Star on OpenWebUI Extensions would be a great motivation for me. Thank you!

Troubleshooting

  • Agent ignores uploaded files? → Install the Files Filter so Copilot can process them directly (see above)
  • Errors after update? → Restart your OpenWebUI server to clear cached bytecode