contributor
Guides external contributors through the MCP SDL3 Server contribution process. Use when someone wants to contribute to the project, add SDL3 functions, implement new features, or understand the contribution workflow. Covers quick start, project structure, testing requirements, and submission guidelines.
安装与使用
请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。
查看来源 ↗使用指南技能说明
Contributor Skill
Guides external contributors through the MCP SDL3 Server contribution workflow.
Quick Start
- Fork and clone the repository
- Install dependencies:
uv sync - Test the server:
uv run mcp-sdl --help
Making Contributions
Adding SDL3 Functions
- Update the appropriate category file in
api/with new function documentation - Test changes:
uv run mcp-sdl --help - Update documentation if needed
Adding New Tools
- Define the tool function in
tools.pywith type hints and docstring - Register it in
server.pyusingmcp.tool(your_function) - Test the tool works correctly
- Update the README's "Available Tools" section
Testing
Run tests before submitting:
uv run pytest --cov --cov-report=term-missing
Requirements: 100% test coverage for all new code.
Contribution Workflow
- Fork the repository
- Create a feature branch:
git checkout -b feature/your-feature - Make your changes
- Test your changes locally
- Commit with clear messages:
git commit -m "Add: description" - Push to your fork:
git push origin feature/your-feature - Open a Pull Request
Getting Help
- Review existing code in
tools.pyfor implementation patterns - See copilot-instructions.md for detailed project conventions
- Open an issue for questions or discussions
Note: For detailed implementation patterns and code quality standards, the AI will automatically use the mcp-developer skill when making code changes.
使用示例
查看来源仓库中的使用示例与配置说明。
查看来源 ↗来源历史
- 收录时间
- 2026-01-20
- 索引更新时间
- 2026-01-26
- Branch
- main
收录与同步日期属于本站记录。源码修改历史请查看来源仓库。
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!