[PR #103] [CLOSED] feat: Add custom header support for SSE connections #171

New issue

Closed

opened 2026-10-18 21:12:24 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-18 21:12:24 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/mcpo/pull/103
Author: @zsiddique
Created: 4/27/2025
Status: ❌ Closed

Base: dev ← Head: main

📝 Commits (4)

3da8462 add headers support for sse
6edc95d fix mising arg and json for headers
f7d4ae8 Add test
6f70218 Merge branch 'dev' into main

📊 Changes

6 files changed (+409 additions, -244 deletions)

View changed files

📝 README.md (+11 -1)
📝 pyproject.toml (+1 -0)
📝 src/mcpo/__init__.py (+4 -0)
📝 src/mcpo/main.py (+16 -3)
➕ src/mcpo/tests/test_sse_client.py (+120 -0)
📝 uv.lock (+257 -240)

📄 Description

Pull Request Checklist

Before submitting, make sure you've checked the following:

Target branch: Please verify that the pull request targets the dev branch.
Description: Provide a concise description of the changes made in this pull request.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Have you written and run sufficient tests to validate the changes?
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
- BREAKING CHANGE: Significant changes that may affect compatibility
- build: Changes that affect the build system or external dependencies
- ci: Changes to our continuous integration processes or workflows
- chore: Refactor, cleanup, or other non-functional code changes
- docs: Documentation update or addition
- feat: Introduces a new feature or enhancement to the codebase
- fix: Bug fix or error correction
- i18n: Internationalization or localization changes
- perf: Performance improvement
- refactor: Code restructuring for better maintainability, readability, or scalability
- style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
- test: Adding missing tests or correcting existing tests
- WIP: Work in progress, a temporary label for incomplete or ongoing work

Changelog Entry

Description

This PR adds support for passing custom HTTP headers to SSE connections in the mcpo tool. This enhances the flexibility of the SSE client by allowing users to include authentication tokens and other custom headers when connecting to SSE servers. The implementation ensures backward compatibility with existing configurations. The motivation for this change was support Home Assistant built in MCP SSE

Added

Added support for optional HTTP headers in SSE connections
Added --headers command-line option for specifying headers as a JSON string
Added headers configuration in the config.json file format for SSE servers
Added comprehensive test cases for the new header functionality

Changed

Updated the SSE client initialization to accept and use custom headers
Updated documentation in README.md to demonstrate how to use the new headers feature

Deprecated

[List any deprecated functionality or features that have been removed]

Removed

[List any removed features, files, or functionalities]

Fixed

N/A

Security

Enhanced security by supporting authentication headers for SSE connections

Breaking Changes

N/A

Additional Information

Dependencies

Added pytest-asyncio>=0.21.1 as a dev dependency for proper async test support.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/mcpo/pull/103 **Author:** [@zsiddique](https://github.com/zsiddique) **Created:** 4/27/2025 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `main` --- ### 📝 Commits (4) - [`3da8462`](https://github.com/open-webui/mcpo/commit/3da846254f7156b94e55fe49d7c90a042ebe3c42) add headers support for sse - [`6edc95d`](https://github.com/open-webui/mcpo/commit/6edc95da71d3c95c0337437628fdc59c5098bc5a) fix mising arg and json for headers - [`f7d4ae8`](https://github.com/open-webui/mcpo/commit/f7d4ae8008650936d164a7a51211707ceeea2a58) Add test - [`6f70218`](https://github.com/open-webui/mcpo/commit/6f70218910e5f213bc316c89bfa19dec09178bef) Merge branch 'dev' into main ### 📊 Changes **6 files changed** (+409 additions, -244 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+11 -1) 📝 `pyproject.toml` (+1 -0) 📝 `src/mcpo/__init__.py` (+4 -0) 📝 `src/mcpo/main.py` (+16 -3) ➕ `src/mcpo/tests/test_sse_client.py` (+120 -0) 📝 `uv.lock` (+257 -240) </details> ### 📄 Description # Pull Request Checklist **Before submitting, make sure you've checked the following:** - [x] **Target branch:** Please verify that the pull request targets the `dev` branch. - [x] **Description:** Provide a concise description of the changes made in this pull request. - [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description. - [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [x] **Testing:** Have you written and run sufficient tests to validate the changes? - [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards? - [x] **Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following: - **BREAKING CHANGE**: Significant changes that may affect compatibility - **build**: Changes that affect the build system or external dependencies - **ci**: Changes to our continuous integration processes or workflows - **chore**: Refactor, cleanup, or other non-functional code changes - **docs**: Documentation update or addition - **feat**: Introduces a new feature or enhancement to the codebase - **fix**: Bug fix or error correction - **i18n**: Internationalization or localization changes - **perf**: Performance improvement - **refactor**: Code restructuring for better maintainability, readability, or scalability - **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.) - **test**: Adding missing tests or correcting existing tests - **WIP**: Work in progress, a temporary label for incomplete or ongoing work # Changelog Entry ### Description This PR adds support for passing custom HTTP headers to SSE connections in the mcpo tool. This enhances the flexibility of the SSE client by allowing users to include authentication tokens and other custom headers when connecting to SSE servers. The implementation ensures backward compatibility with existing configurations. The motivation for this change was support Home Assistant built in MCP SSE ### Added Added support for optional HTTP headers in SSE connections Added --headers command-line option for specifying headers as a JSON string Added headers configuration in the config.json file format for SSE servers Added comprehensive test cases for the new header functionality ### Changed Updated the SSE client initialization to accept and use custom headers Updated documentation in [README.md](vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/code/electron-sandbox/workbench/workbench.html) to demonstrate how to use the new headers feature ### Deprecated - [List any deprecated functionality or features that have been removed] ### Removed - [List any removed features, files, or functionalities] ### Fixed N/A ### Security Enhanced security by supporting authentication headers for SSE connections ### Breaking Changes N/A --- ### Additional Information Dependencies Added pytest-asyncio>=0.21.1 as a dev dependency for proper async test support. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-18 21:12:24 +00:00