Skip to content

Commit c910159

Browse files
CarlosIbCuCarlosIbCu
committed
Update documentation and workflows
1 parent 818af1f commit c910159

20 files changed

+2465
-510
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 19 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,31 @@
11
---
2-
name: 🐛 Bug Report
2+
name: Bug Report
33
about: Create a report to help us improve the MCP tutorial
44
title: '[BUG] '
5-
labels: ['bug', 'needs-triage']
5+
labels: bug
66
assignees: ''
77
---
88

9-
## 🐛 Bug Description
10-
<!-- A clear and concise description of what the bug is -->
9+
**Describe the Bug**
10+
A clear and concise description of what the bug is.
1111

12-
## 📍 Location
13-
<!-- Which part of the tutorial is affected? -->
14-
- [ ] Beginner notebooks (01-05)
15-
- [ ] Intermediate notebooks (06-10)
16-
- [ ] Advanced notebooks (11-17)
17-
- [ ] Weather MCP example
18-
- [ ] Database Manager example
19-
- [ ] File Processor example
20-
- [ ] Documentation
21-
- [ ] Setup/Installation
22-
23-
**Specific file**: <!-- e.g., notebooks/beginner/03_your_first_mcp.ipynb -->
24-
25-
## 🔄 Steps to Reproduce
26-
<!-- Steps to reproduce the behavior -->
27-
1. Go to '...'
12+
**To Reproduce**
13+
Steps to reproduce the behavior:
14+
1. Go to notebook '...'
2815
2. Run cell '...'
29-
3. Execute command '...'
30-
4. See error
31-
32-
## 💻 Expected Behavior
33-
<!-- A clear description of what you expected to happen -->
34-
35-
## 📸 Actual Behavior
36-
<!-- What actually happened? Include error messages, screenshots, etc. -->
37-
38-
```
39-
Paste error message or unexpected output here
40-
```
16+
3. See error
4117

42-
## 🖥️ Environment
43-
<!-- Please complete the following information -->
44-
- **OS**: [e.g. macOS 13.0, Windows 11, Ubuntu 22.04]
45-
- **Python version**: [e.g. 3.9.7]
46-
- **Jupyter version**: [e.g. Lab 3.6.0, Notebook 6.4.0]
47-
- **Browser** (if relevant): [e.g. Chrome 108, Safari 16]
48-
- **Virtual environment**: [e.g. venv, conda, pipenv]
18+
**Expected Behavior**
19+
A clear and concise description of what you expected to happen.
4920

50-
## 📦 Dependencies
51-
<!-- If relevant, paste the output of: pip list | grep -E "(mcp|jupyter|fastapi)" -->
52-
```
53-
# Paste relevant package versions here
54-
```
55-
56-
## 🔧 Additional Context
57-
<!-- Add any other context about the problem here -->
58-
- [ ] This issue appears to be related to a specific operating system
59-
- [ ] This issue might be environment-specific
60-
- [ ] This worked in a previous version
61-
- [ ] I've searched existing issues and this is not a duplicate
62-
63-
## 🤝 Contribution
64-
<!-- Optional: Are you willing to help fix this? -->
65-
- [ ] I'd like to work on fixing this issue
66-
- [ ] I can provide additional testing
67-
- [ ] I have a potential solution in mind
68-
69-
---
21+
**Screenshots**
22+
If applicable, add screenshots to help explain your problem.
7023

71-
**Thank you for helping improve the MCP tutorial! 🙏**
24+
**Environment (please complete the following information):**
25+
- OS: [e.g. macOS, Windows, Linux]
26+
- Python Version: [e.g. 3.8.10]
27+
- Jupyter Version: [e.g. Lab 3.0]
28+
- MCP Version: [e.g. 1.0.0]
7229

73-
> 💡 **Pro tip**: The more details you provide, the faster we can help you!
74-
> ⭐ Don't forget to star the repo if this tutorial is helpful!
30+
**Additional Context**
31+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,38 @@
11
---
2-
name: 💡 Feature Request
2+
name: Feature Request
33
about: Suggest an idea for the MCP tutorial
44
title: '[FEATURE] '
5-
labels: ['enhancement', 'feature-request']
5+
labels: enhancement
66
assignees: ''
77
---
88

9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Target Audience**
19+
Who would benefit from this feature?
20+
- [ ] Beginners
21+
- [ ] Intermediate users
22+
- [ ] Advanced users
23+
- [ ] Enterprise teams
24+
25+
**Additional context**
26+
Add any other context or screenshots about the feature request here.
27+
928
## 🚀 Feature Summary
1029
<!-- A clear and concise description of what you want to happen -->
1130

1231
## 🎯 Motivation
1332
<!-- Why is this feature needed? What problem does it solve? -->
14-
**Is your feature request related to a problem?**
1533
- [ ] Yes, I'm frustrated when...
1634
- [ ] No, this is an enhancement
1735

18-
**Problem description**:
19-
<!-- A clear description of what the problem is. Ex. I'm always frustrated when [...] -->
20-
2136
## 💡 Proposed Solution
2237
<!-- Describe the solution you'd like -->
2338

‎.github/description.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Complete guide for building AI tools and integrations using Model Context Protocol (MCP). Includes tutorials, examples, and best practices for AI development.

‎.github/pull_request_template.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## Description
2+
Please include a summary of the changes and which issue is fixed. Include relevant motivation and context.
3+
4+
Fixes # (issue)
5+
6+
## Type of change
7+
Please delete options that are not relevant.
8+
9+
- [ ] Bug fix (non-breaking change which fixes an issue)
10+
- [ ] New feature (non-breaking change which adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] Documentation update
13+
14+
## Checklist
15+
- [ ] My code follows the style guidelines of this project
16+
- [ ] I have performed a self-review of my code
17+
- [ ] I have commented my code, particularly in hard-to-understand areas
18+
- [ ] I have made corresponding changes to the documentation
19+
- [ ] My changes generate no new warnings
20+
- [ ] I have added tests that prove my fix is effective or that my feature works
21+
- [ ] New and existing unit tests pass locally with my changes
22+
- [ ] Any dependent changes have been merged and published in downstream modules
23+
24+
## Additional Notes
25+
Add any other context about the pull request here.

‎.github/topics.txt‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
mcp
2+
model-context-protocol
3+
ai-tools
4+
machine-learning
5+
python
6+
tutorial
7+
ai-development
8+
llm
9+
tool-integration
10+
jupyter-notebook
11+
fastapi
12+
pydantic
13+
async-python
14+
enterprise-ai
15+
ai-engineering
16+
best-practices
17+
production-ready
18+
ai-tutorial

‎.github/workflows/docs.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Documentation
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
docs:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v3
15+
- name: Set up Python
16+
uses: actions/setup-python@v4
17+
with:
18+
python-version: '3.10'
19+
20+
- name: Install dependencies
21+
run: |
22+
python -m pip install --upgrade pip
23+
pip install -r requirements.txt
24+
pip install mkdocs mkdocs-material jupyter-book
25+
26+
- name: Build documentation
27+
run: |
28+
jupyter-book build notebooks/
29+
30+
- name: Deploy to GitHub Pages
31+
if: github.ref == 'refs/heads/main'
32+
uses: peaceiris/actions-gh-pages@v3
33+
with:
34+
github_token: ${{ secrets.GITHUB_TOKEN }}
35+
publish_dir: ./notebooks/_build/html

‎.github/workflows/test.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Test MCP Tutorial
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
matrix:
14+
python-version: [3.8, 3.9, "3.10"]
15+
16+
steps:
17+
- uses: actions/checkout@v3
18+
- name: Set up Python ${{ matrix.python-version }}
19+
uses: actions/setup-python@v4
20+
with:
21+
python-version: ${{ matrix.python-version }}
22+
23+
- name: Install dependencies
24+
run: |
25+
python -m pip install --upgrade pip
26+
pip install -r requirements.txt
27+
pip install pytest nbval jupyter
28+
29+
- name: Test notebooks
30+
run: |
31+
pytest --nbval notebooks/
32+
33+
- name: Test example projects
34+
run: |
35+
for d in examples/*/; do
36+
if [ -f "$d/requirements.txt" ]; then
37+
cd "$d"
38+
pip install -r requirements.txt
39+
pytest
40+
cd ../..
41+
fi
42+
done

‎.gitignore‎

Lines changed: 51 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,64 @@ wheels/
2222
*.egg-info/
2323
.installed.cfg
2424
*.egg
25-
MANIFEST
2625

27-
# Virtual environments
26+
# Jupyter Notebook
27+
.ipynb_checkpoints
28+
*/.ipynb_checkpoints/*
29+
profile_default/
30+
ipython_config.py
31+
32+
# Virtual Environment
2833
venv/
2934
env/
3035
ENV/
36+
.env
37+
.venv
3138
env.bak/
3239
venv.bak/
33-
mcp_env/
34-
mcp_dev/
3540

36-
# Jupyter Notebook
37-
.ipynb_checkpoints
41+
# IDE
42+
.idea/
43+
.vscode/
44+
*.swp
45+
*.swo
46+
.project
47+
.pydevproject
48+
.settings/
49+
50+
# Documentation
51+
_build/
52+
_static/
53+
_templates/
54+
55+
# Testing
56+
.coverage
57+
htmlcov/
58+
.pytest_cache/
59+
.tox/
60+
nosetests.xml
61+
coverage.xml
62+
*.cover
63+
.hypothesis/
64+
65+
# Logs
66+
*.log
67+
logs/
68+
log/
69+
70+
# OS
71+
.DS_Store
72+
Thumbs.db
73+
*.bak
74+
*.tmp
75+
*.temp
76+
77+
# Project specific
78+
examples/**/data/
79+
notebooks/_build/
80+
resources/temp/
81+
*.env
82+
config.local.yaml
3883

3984
# Environment variables
4085
.env

0 commit comments

Comments
 (0)