Skip to content

README.md

Latest commit

 

History

History
174 lines (120 loc) · 7.6 KB

README.md

File metadata and controls

174 lines (120 loc) · 7.6 KB

🎨 monday.com Apps Framework Tools

The Apps Framework Tools provide AI agents with complete access to monday.com's app development platform. These tools enable you to build, manage, and deploy custom monday.com apps directly through AI assistants.

What is the monday.com Apps Framework?

The monday.com Apps Framework allows developers to build custom applications that extend monday.com's functionality. With these tools, AI agents can:

  • Create and manage apps - Build new apps or modify existing ones
  • Configure app features - Add custom views, columns, widgets, and integrations
  • Manage app versions - Control version lifecycle and promotions
  • Deploy to monday-code - Manage serverless backend deployments
  • Handle app storage - Query and manage app data storage

How to Enable Apps Framework Tools

To enable the Apps Framework tools, add the --mode apps flag to your MCP configuration:

For Cursor or Local MCP Setup

{
  "mcpServers": {
    "monday-apps-mcp": {
      "command": "npx",
      "args": ["@mondaydotcomorg/monday-api-mcp@latest", "-t", "your_monday_api_token", "--mode", "apps"]
    }
  }
}

Available Apps Framework Tools

Category Tool Description
App Management get_all_apps Retrieve all the development apps that the user has collaboration permissions for
create_app Create a new monday.com app with basic information (name and optional description)
promote_app Promote a specific app version to live/production status
App Versions get_app_versions Retrieve all versions of a specific app
get_app_version Retrieve detailed data for a specific app version by version ID
App Features get_app_features Retrieve all features (views, columns, integrations, etc.) for a specific app version
create_app_feature Create a new feature for a specific app version (custom columns, board views, widgets, etc.)
monday-code Deployment get_deployment_status Get the deployment status for a specific app version in monday-code
set_environment_variable Set or update an environment variable for an app's monday-code backend
Storage Management search_storage_records Search for storage records in an app by search term
export_storage_data Export all storage data from an app for a specific account
App Development Assistant get_development_context Get comprehensive documentation for building monday.com apps including SDK usage, deployment guides, and best practices

Example Use Cases

Here are some examples of what you can build with Apps Framework tools:

1. Build a Custom App

"Create a new monday.com app called 'Task Analyzer' that adds a custom status column to track task complexity"

2. Manage App Deployments

"Check the deployment status of my app version and set the API_KEY environment variable"

3. Query App Storage

"Search for all storage records in app 12345 for account 67890 containing 'user_preferences'"

4. Version Management

"Show me all versions of my app and promote the latest draft version to production"

Prerequisites for Apps Framework Tools

To use the Apps Framework tools, you need:

  1. A monday.com developer account with developer mode enabled
  2. Familiarity with the monday.com Apps Framework

Tool Categories

App Management Tools

Tools for creating and managing monday.com apps at the top level.

  • get_all_apps: List all apps you have access to
  • create_app: Create a new app with basic configuration
  • promote_app: Promote an app version to production

App Version Tools

Tools for managing different versions of your apps.

  • get_app_versions: List all versions of a specific app
  • get_app_version: Get detailed information about a specific version

App Feature Tools

Tools for adding and configuring app features like custom columns, views, and widgets.

  • get_app_features: List all features in an app version
  • create_app_feature: Add a new feature to an app version

Supported feature types include:

  • AppFeatureStatusColumn - Custom status columns
  • AppFeatureBoardView - Custom board views
  • AppFeatureItemView - Custom item views
  • AppFeatureDashboardWidget - Dashboard widgets
  • AppFeatureObject - Custom objects
  • And many more...

monday-code Tools

Tools for managing your app's serverless backend deployment on monday-code.

  • get_deployment_status: Monitor deployment progress and logs
  • set_environment_variable: Configure runtime environment variables

Storage Tools

Tools for querying and exporting data stored by your apps.

  • search_storage_records: Find specific records in app storage
  • export_storage_data: Export all storage data (JSON or CSV)

App Development Assistant Tools

Tools that provide comprehensive documentation and guidance for building monday.com apps.

  • get_development_context: Get complete documentation including:
    • Quick start guides for creating new apps
    • monday.com SDK reference and usage examples
    • monday-code deployment instructions (including mapps code:push)
    • Best practices for performance, security, and error handling
    • Troubleshooting common issues
    • CLI commands reference

Context types available:

  • full - Complete guide (default)
  • quick_start - Getting started guide
  • sdk_reference - SDK usage and examples
  • monday_code_deployment - Deployment guide
  • best_practices - Coding standards and patterns
  • troubleshooting - Common issues and solutions

Example usage:

"Help me build a board view app" → Uses SDK reference + app features context
"Deploy my app to monday-code" → Uses deployment context with CLI commands
"My app is showing CORS errors" → Uses troubleshooting context

Integration with Agent Toolkit

These tools are part of the @mondaydotcomorg/agent-toolkit package and can be used programmatically:

import { allMondayAppsTools } from '@mondaydotcomorg/agent-toolkit';

// Use with your AI agent implementation

Learn More