GITHUB_SETUP.md•3.39 kB
# GitHub Repository Configuration
Use these settings when configuring your repository on GitHub.
## Repository Description
```
Model Context Protocol server for UniProtKB protein data - seamless access to entries, sequences, GO annotations, and ID mappings for LLM agents
```
## Website URL
```
https://pypi.org/project/uniprot-mcp/
```
## Topics (GitHub Tags)
Add these topics to help others discover your repository:
```
model-context-protocol
mcp
mcp-server
uniprot
uniprotkb
protein-data
bioinformatics
computational-biology
llm
ai-agent
python
fastmcp
streamable-http
rest-api
protein-database
```
## Repository Features
Enable these features in Settings → General:
- ✅ **Wikis** - For extended documentation
- ✅ **Issues** - Bug tracking and feature requests
- ✅ **Discussions** - Community Q&A
- ✅ **Projects** - For roadmap tracking
- ✅ **Sponsorships** - Enable GitHub Sponsors (optional)
## Branch Protection Rules
Recommended settings for `main` branch (Settings → Branches):
- ✅ Require a pull request before merging
- ✅ Require approvals: 1
- ✅ Dismiss stale pull request approvals when new commits are pushed
- ✅ Require status checks to pass before merging
- ✅ Require branches to be up to date before merging
- Required checks: `Lint, Type Check, and Test (3.11)`, `Lint, Type Check, and Test (3.12)`
- ✅ Require conversation resolution before merging
- ✅ Include administrators (apply rules to admins too)
## Security Settings
Enable in Settings → Security:
- ✅ **Dependency graph** - Track dependencies
- ✅ **Dependabot alerts** - Security vulnerability alerts
- ✅ **Dependabot security updates** - Auto-create PRs for security fixes
- ✅ **Dependabot version updates** - Configured via `.github/dependabot.yml`
- ✅ **Code scanning** - GitHub Advanced Security (if available)
- ✅ **Secret scanning** - Detect committed secrets
## Social Preview Image
Generate a social preview image (1280×640px) showing:
- Project name: "UniProt MCP Server"
- Tagline: "Protein data for AI agents"
- Key features: "FastMCP • Typed • Resilient"
- Technologies: Python, MCP, UniProt logos
Upload in Settings → General → Social preview
## About Section
Configure in repository homepage "About" section:
- Description: (use description above)
- Website: https://pypi.org/project/uniprot-mcp/
- Topics: (use topics above)
- ✅ Releases
- ✅ Packages
- ✅ Used by (show dependents)
## Quick Setup Commands
```bash
# After creating repository on GitHub, push existing code:
git remote add origin https://github.com/josefdc/Uniprot-MCP.git
git branch -M main
git push -u origin main --tags
# Enable GitHub Pages (optional) for documentation:
# Settings → Pages → Source: GitHub Actions
# Add a docs/ workflow to deploy documentation
```
## Badges to Add
The README already includes:
- PyPI version
- Python versions
- License
- MCP Registry
Optional additional badges:
```markdown
[](https://github.com/josefdc/Uniprot-MCP/actions)
[](https://codecov.io/gh/josefdc/Uniprot-MCP)
[](https://github.com/astral-sh/ruff)
```