Skip to content

docs: add API endpoints information to MCP documentation #1062

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

claude[bot]
Copy link
Contributor

@claude claude bot commented Aug 8, 2025

Summary

Added documentation to the MCP page explaining that MCP also provides access to Windmill's API endpoints for basic operations on:

  • Jobs - Monitor and manage job executions
  • Scripts - Create, read, update, and delete scripts
  • Flows - Manage workflow definitions and executions
  • Resources - Handle resource configurations
  • Variables - Manage workspace variables and secrets
  • Schedules - Control scheduled executions
  • Workers - Monitor worker status and configuration

Changes

  • Modified docs/core_concepts/51_mcp/index.mdx to include API endpoint capabilities after the main introduction
  • Used concise, technical language following the writing style guide
  • Added bullet points with clear descriptions for each endpoint type

Closes #1061

Generated with Claude Code

Add information about MCP''s access to Windmill API endpoints for basic operations on jobs, scripts, flows, resources, variables, schedules, and workers.

Closes #1061

Co-authored-by: windmill-internal-app[bot] <windmill-internal-app[bot]@users.noreply.github.com>
@centdix
Copy link
Contributor

centdix commented Aug 8, 2025

/ai remove scripts and flows, and add backlinks to each concept when possible. also read each concept yourself to put better descriptions on each endpoint group

Copy link
Contributor Author

claude bot commented Aug 8, 2025

Claude finished @centdix's task —— View job


Task completed successfully ✅

Todo List:

  • Read current MCP documentation file
  • Read documentation for Jobs, Resources, Variables, Schedules, and Workers concepts
  • Remove Scripts and Flows from API endpoints list
  • Add backlinks to each remaining concept
  • Improve descriptions based on concept documentation
  • Commit and push changes

Summary

I've successfully updated the MCP documentation as requested:

Changes made:

  • Removed Scripts and Flows from the API endpoints list
  • Added backlinks to each concept page (Jobs, Resources, Variables, Schedules, Workers)
  • Improved descriptions based on the actual concept documentation to be more specific and technical:
    • Jobs: Now mentions tracking progress, retrieving logs, and viewing execution results
    • Resources: Clarifies third-party system connections like databases and APIs
    • Variables: Emphasizes secure credential storage and configuration management
    • Schedules: Specifies CRON-like automation for scripts and flows
    • Workers: Details worker groups and resource allocation

The descriptions are now more accurate and follow the writing style guide by being concise and technical rather than overly promotional.

…cklinks

- Remove Scripts and Flows from API endpoints list
- Add backlinks to Jobs, Resources, Variables, Schedules, and Workers concept pages
- Improve descriptions based on actual concept documentation to be more specific and technical

Co-authored-by: centdix <[email protected]>
Copy link

cloudflare-workers-and-pages bot commented Aug 8, 2025

Deploying windmilldocs with  Cloudflare Pages  Cloudflare Pages

Latest commit: d3b8b06
Status: ✅  Deploy successful!
Preview URL: https://f88cac9c.windmilldocs.pages.dev
Branch Preview URL: https://claude-issue-1061-20250808-1.windmilldocs.pages.dev

View logs

@centdix
Copy link
Contributor

centdix commented Aug 8, 2025

/ai also add an entry in the changelog related to this

Copy link
Contributor Author

claude bot commented Aug 8, 2025

Claude finished @centdix's task —— View job


Task completed successfully ✅

Todo List:

  • Find the changelog file in the repository
  • Read the changelog to understand format and structure
  • Add an appropriate entry for the MCP documentation changes
  • Commit and push changes to the PR branch

Summary

I've successfully added a changelog entry for the MCP API endpoints documentation update. The new entry includes:

Created: changelog/2025-08-08-mcp-api-endpoints-docs/index.md

Key details:

  • Title: MCP API endpoints documentation
  • Version: v1.520.0 (matching the latest entries)
  • Tags: MCP, Documentation, API
  • Features: Documents the addition of comprehensive API endpoints information, detailed descriptions for each endpoint type, direct links to concept documentation, and technical focus on capabilities

The changelog entry follows the established format and style of existing entries, emphasizing the documentation enhancement rather than new functionality.


@centdix
Copy link
Contributor

centdix commented Aug 8, 2025

/ai the changelog should be about the improvements on the mcp, not about the added documentation

Copy link
Contributor Author

claude bot commented Aug 8, 2025

Claude finished @centdix's task —— View job


Task completed successfully ✅

Todo List:

  • Read the current changelog entry to understand what needs to be changed
  • Read the MCP documentation to understand the improvements to highlight
  • Rewrite the changelog entry to focus on MCP capabilities rather than documentation
  • Commit and push changes to the PR branch

Summary

I've successfully updated the changelog entry to focus on MCP improvements rather than documentation changes.

Changes made:

  • Title: Changed from "MCP API endpoints documentation" → "MCP API endpoints support"
  • Tags: Updated to focus on functionality rather than documentation
  • Description: Now emphasizes the API endpoints as a feature improvement enabling programmatic workspace management
  • Features: Rewritten to highlight the actual capabilities each endpoint provides:
    • Job management with progress tracking and log retrieval
    • Resource configuration for third-party connections
    • Variable/secrets management with secure storage
    • Schedule management with CRON-like automation
    • Worker monitoring and resource allocation

The changelog now properly represents this as a feature enhancement to MCP rather than just a documentation update.


Updated the changelog entry to highlight the MCP functionality improvements
rather than the documentation additions, focusing on the API endpoints
that enable programmatic workspace management.

Co-authored-by: centdix <[email protected]>
@centdix centdix marked this pull request as ready for review August 11, 2025 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs for api endpoints with mcp
1 participant