René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Define and document the public Python SDK API surface","articleBody":"### Description\n\n## Summary\n\nThe Python SDK exposes a variety of classes and functions across packages and submodules. Some are clearly meant to be public, others are internal but not marked as such. Tests and user code sometimes rely on internals (e.g. private attributes).\n\nThis makes it hard for users to know what is safe to depend on and hard for maintainers to evolve internals without risking breakage.\n\n## Problems\n\n- **Ambiguous boundaries:** It’s not always clear which symbols in `mcp.*` and subpackages are part of the supported public API.\n- **Private attribute usage:** Some tests/examples access internal attributes (e.g. `_mcp_server`), which blurs the line between public and internal.\n- **Versioning risk:** Changes to internal structures can accidentally turn into breaking changes for users who imported them directly.\n\n## Proposal\n\n1. **Define an explicit public API**\n\n   - Use `__all__` and/or a `mcp.public` (or similar) module to list what is considered stable public API.\n   - Document the intended public surface in the README or a dedicated “API Reference”.\n\n2. **Mark internals clearly**\n\n   - Move clearly internal modules into an `_internal` subpackage where possible.\n   - Use leading underscores and documentation to indicate non-public attributes.\n\n3. **Gradual tightening**\n\n   - Update examples and tests to use only public APIs where feasible.\n   - Where users are expected to interact with lower-level constructs, expose them via documented, stable paths.\n\n## Why this matters\n\n- **Stability:** Users can rely on documented APIs without fear of accidental breakage.\n- **Refactorability:** Internal changes become safer when the public surface is well-defined.\n- **Onboarding:** New users can quickly see which APIs are meant for them.\n\n## Acceptance criteria\n\n- [ ] A documented list of public, supported APIs for the Python SDK.\n- [ ] Internal modules/types are clearly marked (e.g., `_internal` packages) where appropriate.\n- [ ] Examples and tests avoid relying on private attributes when a public alternative exists.\n- [ ] Future changes can be evaluated against this public surface for compatibility.\n\n\n### References\n\n_No response_","author":{"url":"https://github.com/dgenio","@type":"Person","name":"dgenio"},"datePublished":"2025-11-28T15:39:36.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":4},"url":"https://github.com/1701/python-sdk/issues/1701"}