Rovo MCP is available through Forge's Early Access Program (EAP). The EAP allows all Forge developers for testing and feedback. APIs and features in EAP are experimental, unsupported, subject to change without notice, and not recommended for production use.
For more details, see Forge EAP, Preview, and GA.
When you use Rovo APIs, you must comply with the Atlassian Acceptable Use Policy, including the section titled “Artificial intelligence offerings and features.” For the protection of our customers, Atlassian performs safety screening on Agents at our sole discretion. If we identify any issues with your Agent, we may take protective actions, such as preventing the Agent from being deployed or suspending your use of Rovo APIs. Where possible we will notify you of the nature of the issue, and you must use reasonable commercial efforts to correct the issue before deploying your Agent again.
This tutorial walks through creating a Forge app that adds a Rovo MCP module. You will also create an action, which the MCP module exposes as a tool that custom agents in Rovo Studio can invoke with input from the user's chat.
At the end of this tutorial, you’ll have created a Forge app that exposes a tool that can take a user's prompt and log a simple hello world message inside a Forge function.
To expose tools to Rovo, you must have Rovo activated.
Complete Getting started before working through this tutorial.
Install @forge/cli version 13.3.0 or higher.
To install:
npm install -g @forge/cli@latest or
npm install -g @forge/cli@^13.3.0
Create your app by running:
1 2forge create
Enter a name for your app. For example hello-world-rovo-mcp.
Select the Show All category.
Select the blank template.
Change to the app subdirectory to see the app files.
1 2cd hello-world-rovo-mcp
Add the rovo:mcp module to your app by running:
1 2forge module add
Select the Rovo product.
Select the rovo:mcp module.
Follow the prompts to enter a module key and MCP name. These can be updated later. This tutorial uses the module key hello-world-mcp and the MCP name Hello world MCP.
Running forge module add updates your manifest.yml and generates a starter function file for the
module. It adds a rovo:mcp module with a default Log a message action (exposed as a tool) and
creates src/hello-world-mcp.js with a messageLogger function that backs the action.
Your app now has the following structure:
1 2├── manifest.yml ├── package.json └── src ├── hello-world-mcp.js └── index.js
The src/index.js file and the my-function module are left over from the blank template and aren't
used by the MCP module. The next steps remove them so the app only contains what the tool needs.
Open your manifest.yml file and remove the leftover my-function entry from the function list so
your manifest matches the following (your app ID is already filled in):
For a detailed understanding of the manifest structure, refer to the Rovo MCP module.
1 2modules: rovo:mcp: - key: hello-world-mcp name: Hello world MCP tools: - hello-world-mcp-logger action: - key: hello-world-mcp-logger name: Log a message function: resolver actionVerb: GET description: > When a user asks to log a message, this action logs the message to the Forge logs. inputs: message: title: Message type: string required: true description: The message that the user has requested be logged to Forge logs function: - key: resolver handler: hello-world-mcp.messageLogger app: runtime: name: nodejs24.x memoryMB: 256 architecture: arm64 id: <your app id>
forge module add creates src/hello-world-mcp.js with a starter messageLogger function that logs the
user-provided message to the console. The hello-world-mcp-logger action in the manifest invokes this
function to log messages as requested by the user.
Update the function to also return a confirmation message. An action's return value passes back to the agent, so returning a value lets the agent confirm the result to the user:
1 2export function messageLogger(payload) { console.log(`Logging message: ${payload.message}`); return `Logged message: ${payload.message}`; }
You can also delete the unused src/index.js file left over from the blank template.
To use your app, it must be installed onto an Atlassian site. The
forge deploy command builds, compiles, and deploys your code; it'll also report any compilation errors.
The forge install command then installs the deployed app onto an Atlassian site with the
required API access.
You must run the forge deploy command before forge install because an installation
links your deployed app to an Atlassian site.
Navigate to the app's top-level directory and deploy your app by running:
1 2forge deploy
Install your app by running:
1 2forge install
Select Confluence using the arrow keys and press the enter key.
This tutorial uses Confluence, but your Forge app isn't tied to a specific Atlassian app. To
install it on Jira or another Atlassian app, select that app here instead.
Enter the URL for your development site. For example, example.atlassian.net. View a list of your active sites at Atlassian administration.
Once the successful installation message appears, your app is installed and ready
to use on the specified site.
You can always delete your app from the site by running the forge uninstall command.
Running the forge install command only installs your app onto the selected site.
To install on additional sites, repeat these steps, selecting another site each time.
You must run forge deploy before running forge install in any of the Forge environments.
With your app installed, your tool is available to custom agents in Rovo Studio.
You should see a Forge log with your message:
The Forge function in the src/hello-world-mcp.js file shapes the behavior of the tool:
1 2export function messageLogger(payload) { console.log(`Logging message: ${payload.message}`); return `Logged message: ${payload.message}`; }
Add a console.log line to inspect the payload object. Your function now looks like this:
1 2export function messageLogger(payload) { console.log(`Logging message: ${payload.message}`); console.log(`Payload: ${JSON.stringify(payload)}`); return `Logged message: ${payload.message}`; }
The payload returns an additional context object, which can contain identifiers relevant to
the user’s current context. Because you installed this app on Confluence, the context includes a
confluence key. If you installed on a different Atlassian app, you'd see that app's key instead
(for example, jira). The following shows the structure of the context property on the payload:
1 2{ "context": { "confluence": { "url": "https://mysite.atlassian.com/wiki/spaces/~61df1116125b12007152148f/pages/10092545/Mypage", "resourceType": "page", "contentId": "10092545", "spaceKey": "~61df1116125b12007152148f", "spaceId": "33248" }, "cloudId": "13c6457e-69c5-4ad4-880a-dbdd77ef39f2", "moduleKey": "hello-world-mcp-logger" } }
These can be useful for checking the identifiers passed in via action inputs, which the LLM can sometimes get wrong.
Now update the function to log an extra message detailing whether the user is on a Confluence page, blog post, or another resource type.
Update your messageLogger function as follows:
1 2export function messageLogger(payload) { console.log(`Logging message: ${payload.message}`); console.log(`Payload: ${JSON.stringify(payload)}`); const message = `The user is on a Confluence ${payload.context?.confluence?.resourceType}`; console.log(message); return message; }
Deploy your app:
1 2forge deploy
Test your tool again by asking the agent to log a message.
Check the logs to verify your tool ran. Go to the developer console, select your app, and navigate to Logs.
You should see Forge logs with your messages.
This content is written with standard cloud development in mind. To learn about developing for Atlassian Government Cloud, go to our Atlassian Government Cloud developer portal.
Rate this page: