Skip to content

πŸš€ The fast, Pythonic way to build MCP servers and clients.

feat: Improve GitHub workflow automation for schema and SDK docs (#1615)

Jeremiah Lowind237de200353
diff --git a/.github/workflows/update-config-schema.yml b/.github/workflows/update-config-schema.yml
index 7c88947fd..bc762c24c 100644
--- a/.github/workflows/update-config-schema.yml
+++ b/.github/workflows/update-config-schema.yml
@@ -42,32 +42,29 @@ jobs:
- name: Generate config schema
run: |
echo "πŸ”„ Generating fastmcp.json schema..."
+
+ # Generate schema in docs/public for web access
uv run python -c "
from fastmcp.utilities.fastmcp_config import generate_schema
generate_schema('docs/public/schemas/fastmcp.json/latest.json')
- print('βœ… Schema generated successfully')
+ print('βœ… Latest schema generated in docs/public')
"
- # Also update the v1 schema for consistency
+ # Also update the v1 schema in docs/public
uv run python -c "
from fastmcp.utilities.fastmcp_config import generate_schema
generate_schema('docs/public/schemas/fastmcp.json/v1.json')
- print('βœ… v1 schema updated')
+ print('βœ… v1 schema generated in docs/public')
"
- - name: Check for changes
- id: check_changes
- run: |
- if git diff --quiet docs/public/schemas/fastmcp.json/; then
- echo "No changes detected in config schema"
- echo "has_changes=false" >> $GITHUB_OUTPUT
- else
- echo "Changes detected in config schema"
- echo "has_changes=true" >> $GITHUB_OUTPUT
- fi
+ # Generate schema in the source directory for local development
+ uv run python -c "
+ from fastmcp.utilities.fastmcp_config import generate_schema
+ generate_schema('src/fastmcp/utilities/fastmcp_config/v1/schema.json')
+ print('βœ… Schema generated in utilities/fastmcp_config/v1/')
+ "
- name: Create Pull Request
- if: steps.check_changes.outputs.has_changes == 'true'
uses: peter-evans/create-pull-request@v7
with:
token: ${{ steps.marvin-token.outputs.token }}
@@ -86,8 +83,5 @@ jobs:
- name: Summary
run: |
- if [ "${{ steps.check_changes.outputs.has_changes }}" == "true" ]; then
- echo "βœ… Config schema PR created"
- else
- echo "βœ… Config schema is already up to date"
- fi
+ echo "βœ… Config schema generation workflow completed"
+ echo "PR will be created if there are changes, or closed if schema is already up to date"
diff --git a/.github/workflows/update-sdk-docs.yml b/.github/workflows/update-sdk-docs.yml
index a23ff3069..ed9ef6f88 100644
--- a/.github/workflows/update-sdk-docs.yml
+++ b/.github/workflows/update-sdk-docs.yml
@@ -47,19 +47,7 @@ jobs:
echo "πŸ”„ Generating SDK documentation..."
just api-ref-all
- - name: Check for changes
- id: check_changes
- run: |
- if git diff --quiet docs/python-sdk/ docs/docs.json; then
- echo "No changes detected in SDK documentation"
- echo "has_changes=false" >> $GITHUB_OUTPUT
- else
- echo "Changes detected in SDK documentation"
- echo "has_changes=true" >> $GITHUB_OUTPUT
- fi
-
- name: Create Pull Request
- if: steps.check_changes.outputs.has_changes == 'true'
uses: peter-evans/create-pull-request@v7
with:
token: ${{ steps.marvin-token.outputs.token }}
@@ -78,8 +66,5 @@ jobs:
- name: Summary
run: |
- if [ "${{ steps.check_changes.outputs.has_changes }}" == "true" ]; then
- echo "βœ… SDK documentation PR created"
- else
- echo "βœ… SDK documentation is already up to date"
- fi
+ echo "βœ… SDK documentation generation workflow completed"
+ echo "PR will be created if there are changes, or closed if documentation is already up to date"