Skip to navigation

Install Zuora MCP server in Visual Studio Code

View as Markdown

Learn how to configure and connect the remote Zuora MCP server in Visual Studio Code so you can use Visual Studio Code to interact with your Zuora tenant.

You must have created an OAuth 2.0 client and obtained the Client ID and Client Secret. For more detailed information, see Create OAuth 2.0 credentials for remote MCP client.

1

Open the MCP configuration file.

In a text editor, open the ~/.vscode/mcp.json file.

2

Add the Zuora MCP server configuration.

Add the following configuration:

{
"servers": {
"zuora-mcp": {
"url": "${mcpEndpoint}",
"type": "http",
"oauth": {
"clientId": "${clientId}"
}
}
},
"inputs": []
}
3

Provide the required configuration values.

Replace the placeholders with your values:

  • mcpEndpoint: The MCP server endpoint for your environment. For the list of endpoints, see Identify your MCP server endpoint.
  • clientId: The OAuth client ID created in OneID.

You do not add the Client Secret to this file. Visual Studio Code prompts you for the Client Secret when you start the server.

4

Manage the MCP server. VS Code provides several options to manage your MCP servers, such as starting or stopping a server, viewing logs, uninstalling, or clearing cached tools. You use either of these two methods

  • Using command Palette: Run MCP: List Servers, select a server, and choose an action.
  • mcp.jsoneditor: Open the configuration file and use the inline actions (code lenses). Use MCP: Open User Configuration or MCP: Open Workspace Folder Configuration to open the file.
5

Complete the authentication.

Follow the prompts in Visual Studio Code to enter the Client Secret, and then complete the authentication step in OneID.

The Zuora MCP server is configured and connected in Visual Studio Code. You can now use Visual Studio Code to interact with your Zuora tenant.

Alternatively, you can use the inline actions (code lenses) in the mcp.json file to start, stop, or restart the server.