docs(python): map connector extras and dependencies - #14344
docs(python): map connector extras and dependencies#14344DDDonut (daleselaji-dev) wants to merge 1 commit into
Conversation
|
DDDonut (@daleselaji-dev) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
There was a problem hiding this comment.
Pull request overview
Adds a centralized Python documentation reference that maps Semantic Kernel connector import roots to their corresponding pip install extras and key upstream version constraints, and links that reference from the Python README to improve discoverability.
Changes:
- Added
python/CONNECTOR_DEPENDENCIES.mddocumenting connector import roots, extras, and selected compatibility-sensitive constraints. - Linked the new connector dependency map from the Python README “Quick Install” section.
- Fixed a malformed bullet in the README documentation links section.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| python/README.md | Adds a link to the connector dependency map and fixes a documentation list item formatting issue. |
| python/CONNECTOR_DEPENDENCIES.md | Introduces a connector-to-extra/version-constraint mapping reference for Python users/contributors. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| | --- | --- | --- | | ||
| | `semantic_kernel.connectors.brave` | **base** | Uses the base HTTP client; configure a Brave Search API key | | ||
| | `semantic_kernel.connectors.google_search` | **base** | Uses the base HTTP client; configure Google Custom Search credentials | | ||
| | `semantic_kernel.connectors.mcp` | `mcp` | The default install already includes `mcp >= 1.26.0,<2.0`; the extra declares `mcp >= 1.8,<2.0` for explicit connector installation | |
There was a problem hiding this comment.
MAF Automated Review — Iteration 1
Result: No findings
Scope: full PR (1 commit(s)): 859a5f8a2ba1
Model: claude-opus-4.8
Overview
This documentation-only PR adds python/CONNECTOR_DEPENDENCIES.md, a hand-maintained map from public connector import roots to install extras and provider version constraints, plus a single link line in python/README.md. All four reviewers independently cross-checked every table row against python/pyproject.toml and the actual module tree under python/semantic_kernel/connectors/: every documented import root exists, every extra name matches a real [project.optional-dependencies] key, and every version constraint (including the ONNX 3.10 split, platform markers, the Cosmos DB dual azure/mongo requirement, and the base-vs-extra mcp pins) mirrors the source of truth exactly. The residual risk is bounded to documentation drift with no CI enforcement and two omitted legacy Cosmos memory_stores roots — both Low-priority and non-blocking. There is no executable code, so no runtime, packaging, or security surface is affected.
Reviewed the supplied pull-request change set across correctness, security/reliability, architecture, and failure behavior.
No publishable findings remained after source verification for this scope.
Problem
Python users and contributors must inspect package metadata and individual connector modules to discover which install extra and upstream version constraints each connector requires.
Root Cause
The dependency extras are declared in
python/pyproject.toml, but there was no single reference mapping public connector import roots to those extras or documenting compatibility-sensitive constraints.Solution
Add a source-backed connector dependency map and link it from the Python README quick-install section.
Changes
python/CONNECTOR_DEPENDENCIES.mdcovering AI, vector-store, memory, search, protocol, and database connectors.python/README.md.Testing
python/pyproject.tomland Markdown files were read as UTF-8 successfully.pre-commit -c python/.pre-commit-config.yaml run --files python/README.md python/CONNECTOR_DEPENDENCIES.mdpassed; all configured hooks were skipped because the changed files are Markdown.git diff --checkpassed.Compatibility/Risk
Documentation-only; no runtime or packaging behavior changes. The version values intentionally mirror
python/pyproject.toml; maintainers should update both files when connector extras change.Notes for Reviewer
Please verify that the public import roots and provider mappings match the current connector exports, especially the base-only AstraDB and NVIDIA entries and the dual
azure/mongorequirement for Cosmos DB.Linked Issue
Closes #14327