Open
Conversation
added 4 commits
October 9, 2025 22:40
- Extract duplicate domain validation logic into _validate_url_domain() - Reduces code duplication in fetch_docs tool - Improves error message consistency by sorting domains - Makes the validation logic more testable and maintainable - Adds comprehensive docstring to fetch_docs inner function This refactoring makes the code cleaner and easier to maintain without changing any functionality.
- Move langgraph.py from mcpdoc/ to examples/ directory - Create examples/README.md with usage documentation - Update test_imports.py to reflect new structure - Improves project organization by separating examples from main package The langgraph.py file is an example implementation, not part of the core package, so it's more appropriate to place it in an examples directory. This makes the project structure clearer for contributors and users.
- Add comprehensive contribution guide - Document development setup with uv - Include code style guidelines and best practices - Provide clear pull request process - Add examples for common development tasks This helps new contributors get started quickly and ensures consistent contribution quality across the project.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR includes several improvements to code quality and project organization:
examples/directoryMotivation
These changes improve code maintainability and make it easier for new contributors to get started with the project.
Changes
Code Quality
_validate_url_domain()helper function to reduce duplication infetch_docstoolfetch_docsinner functionProject Structure
langgraph.pyfrommcpdoc/toexamples/directoryexamples/README.mdwith usage documentation and templatestest_imports.pyto reflect new structureDocumentation
CONTRIBUTING.mdwith:Dependencies
uv.lockto match current version 0.0.10Type of Change
Testing
make lint)make format)uv run mcpdoc --version)Checklist
Additional Notes
These improvements were made with the goal of:
All changes are non-breaking and purely additive/organizational. The refactored code maintains the exact same functionality while being more maintainable and testable.