Skip to content

πŸ€– Add Comprehensive AI Agent Friendly CLI Support #221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Aug 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 93 additions & 0 deletions .github/workflows/generate-llm-txt.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
name: Generate LLM.txt

on:
# Trigger on releases
release:
types: [published]

# Trigger on pushes to main branch
push:
branches: [main]
paths:
- 'src/mcpm/commands/**'
- 'src/mcpm/cli.py'
- 'scripts/generate_llm_txt.py'

# Allow manual trigger
workflow_dispatch:

jobs:
generate-llm-txt:
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write

steps:
- name: Checkout code
uses: actions/checkout@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
fetch-depth: 0

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e .

- name: Generate llm.txt
run: |
python scripts/generate_llm_txt.py

- name: Check for changes
id: check_changes
run: |
if git diff --quiet llm.txt; then
echo "no_changes=true" >> $GITHUB_OUTPUT
else
echo "no_changes=false" >> $GITHUB_OUTPUT
fi

- name: Commit and push changes
if: steps.check_changes.outputs.no_changes == 'false'
run: |
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git add llm.txt
git commit -m "docs: update llm.txt for AI agents [skip ci]"
git push
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Create Pull Request (for releases)
if: github.event_name == 'release' && steps.check_changes.outputs.no_changes == 'false'
uses: peter-evans/create-pull-request@v7
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: "docs: update llm.txt for release ${{ github.event.release.tag_name }}"
title: "πŸ“š Update llm.txt for AI agents (Release ${{ github.event.release.tag_name }})"
body: |
## πŸ€– Automated llm.txt Update

This PR automatically updates the llm.txt file for AI agents following the release of version ${{ github.event.release.tag_name }}.

### Changes
- Updated command documentation
- Refreshed examples and usage patterns
- Updated version information

### What is llm.txt?
llm.txt is a comprehensive guide for AI agents to understand how to interact with MCPM programmatically. It includes:
- All CLI commands with parameters and examples
- Environment variables for automation
- Best practices for AI agent integration
- Error handling and troubleshooting

This file is automatically generated from the CLI structure using `scripts/generate_llm_txt.py`.
branch: update-llm-txt-${{ github.event.release.tag_name }}
delete-branch: true
Loading