Manage app lifecycle with Developer MCP Server

While Freshworks Agentic Developer Toolkit is incredibly powerful, it's important to remember that no AI-powered tool is perfect. In this section, we'll guide you through the crucial step of thoroughly verifying the generated code. Once reviewed, test it, perform review with skills, use publish skill to upload apps to developer portal using MCP configuration and more.

You'll learn how to review, test, and fine-tune the generated code to ensure that your app functions flawlessly. By performing this verification, you'll have complete control and confidence in your app's functionality and can make any necessary adjustments. So, let's ensure your creation is nothing short of perfect!

Review the app using /fw-review skill

Use the fw-review skill as a pre-flight check for your custom apps. It validates that your code meets security, performance, and platform standards before you submit it to the Freshworks Developer Portal.

To identify potential issues and configuration errors, run the following command in the chat interface of your AI assistant:

/fdk-review

The /fdk-review command generates a comprehensive report that identifies specific lines of code or configuration settings requiring remediation. Use the report to locate and resolve complex logic or architectural issues. For common validation errors, use the /fdk-fix command (available via the fw-app-dev skill) to resolve issues automatically.

For a complete list of specific checks performed and advanced configuration options, see the fw-review command reference.

Developer MCP Server Setup

The Freshworks Developer MCP server uses the Model Context Protocol (MCP) to connect your AI assistant to the Freshworks Developer Portal.

Before you publish a custom app, you need to configure the MCP server in your AI assistant.

Prerequisites

Before you begin, make sure you have the following:

  • An active Freshworks Developer Account, if you don't already have one, Sign Up to create a new account.

  • A valid Developer API key associated with the account you intend to upload the app to.

    Follow the steps to obtain the Developer API key:
    1. Go to the Application Management Portal and click the Settings icon in the top-right corner.
    2. Under the API key for Freddy AI Copilot VS Code plugin & Agentic Developer Toolkit section, click View API Key. The API key is displayed.
  • Familiarity with configuring Model Context Protocol (MCP) server in preferred AI assistants.

Configure MCP server in the AI assistant

To configure the server, add the following details to the MCP configuration file of your preferred AI assistant:

  • Name: fw-dev-mcp

  • URL: https://mcp.freshworks.dev/mcp

  • Authorization header: Your Developer API key obtained from the Application Management Portal. See prerequisites.

    Note:Currently, you can publish app to a single product account only. The app is automatically published to the account linked to your configured Developer API key. Ensure you have provided the key for the correct target environment.

Sample MCP JSON configuration code:

{
  "mcpServers": {
    "fw-dev-mcp": {
      "url": "https://mcp.freshworks.dev/mcp",
      "headers": {
        "Authorization": "Bearer <your-api-key>"
      }
    }
  }
}

To learn more about the Developer MCP server and its tools, see Developer Model Context Protocol (MCP) server.

Manage app lifecycle with /fw-publish skill

Use the fw-publish skill to package and upload your project as a custom app to the Freshworks Developer Portal.

Note:The fw-publish skill currently supports the submission of Custom apps only. Support for submitting public apps to the Freshworks Marketplace is currently under development.

Prerequisites

Before you publish your app, make sure you have:

Initiate the app submission

To start the custom app submission process, run the following command in the chat interface of your AI assistant:

/fw-publish

The /fw-publish command automates the following steps:

  • Validation: Verifies your project structure and generates the required .zip package.
  • Deployment: Uploads the app version directly to the Developer Portal and makes it available for the product associated with the provided API key in the MCP configuration.
  • Status tracking: Provides real-time updates on the progress of your marketplace submission.

For detailed configuration options, see the fw-publish command reference.

Note:This command uploads the app to the Developer Portal in the In Development state. To complete the publication, log in to your Developer Portal account, open the app entry, and click Promote to Live > Continue to Publish.

Test the application

  1. Follow the testing instructions for the in development app and perform sanity
  2. Follow the instructions for converting it to custom app, and publish it.