Skip to content
Install in VS Code

Use the Oracle CPQ MCP server with Claude Code, Cursor and GitHub Copilot

Connect your AI agent to the hosted CPQ DevKit™ Oracle MCP server so it can read BML functions, data tables, commerce setup and more from your Oracle CPQ site.

On this page

The CPQ DevKit™ Oracle MCP server is a hosted Model Context Protocol server at https://app.cpqdevkit.com/mcp/oracle. It gives an AI agent tools to look up your Oracle CPQ site: BML util library functions, data tables, commerce processes and documents, parts, files, users, migration packages and more. This guide covers Claude Code, Cursor and GitHub Copilot in VS Code.

Before you start

  • An Oracle CPQ Cloud site with REST API access (standalone BigMachines or Fusion Applications). The BML library tools need REST v19.
  • An Oracle CPQ user that can read, through the REST API, the data you want the agent to see. A dedicated integration user is a good idea.
  • A free CPQ DevKit™ account. You can create one from the Oracle extension or at app.cpqdevkit.com.
  • The AI tool you want to use: VS Code 1.109 or later with GitHub Copilot, Claude Code, or Cursor.

Simplest path: VS Code

If you work in VS Code, you don't need to configure anything by hand:

  1. Install CPQ DevKit™ for Oracle from the VS Code Marketplace.
  2. Run Sign In from the Command Palette. Signing in creates your CPQ DevKit™ API key and keeps it in VS Code secret storage.
  3. Set up your project and add your Oracle CPQ environment. The extension passes the active environment's site address and credentials to the MCP server.

VS Code then lists the CPQ DevKit™ for Oracle MCP server for GitHub Copilot. The server uses the environment that is active when it starts, so restart it after you switch environments.

This automatic setup is for VS Code. Claude Code and Cursor keep their own MCP server lists, so add the server there once, as shown below.

Get an API key

The manual setups below need a CPQ DevKit™ API key:

  1. Sign in at app.cpqdevkit.com.
  2. Create an API key and copy it. The full key is shown only once, so store it somewhere safe, such as your password manager.
  3. Keep the key out of source control. The examples below read it from an environment variable.

What the server needs

The server reads these HTTP headers:

HeaderValue
X-API-KeyYour CPQ DevKit™ API key
X-Oracle-CPQ-Base-URLYour site address, for example https://yoursite.bigmachines.com
X-Oracle-CPQ-UsernameOracle CPQ user name (with X-Oracle-CPQ-Password)
X-Oracle-CPQ-PasswordOracle CPQ password
X-Oracle-CPQ-Access-TokenOptional: an Oracle CPQ OAuth access token, instead of user name and password
X-Oracle-CPQ-Rest-Base-PathOptional: the REST base path, if your site doesn't use the default
X-Oracle-CPQ-Api-VersionOptional: REST API version, v19 by default

The server uses the site address and credentials in each request to call your Oracle CPQ site for that request. The examples below use these environment variables, which you set in your shell profile and then restart your editor or terminal:

export CPQDEVKIT_API_KEY="cpqdk_..."
export ORACLE_CPQ_BASE_URL="https://yoursite.bigmachines.com"
export ORACLE_CPQ_USERNAME="integration.user"
export ORACLE_CPQ_PASSWORD="..."

Claude Code

Add the server with one command. Run it in your project folder:

claude mcp add --transport http cpq-devkit-oracle https://app.cpqdevkit.com/mcp/oracle \
  --header "X-API-Key: $CPQDEVKIT_API_KEY" \
  --header "X-Oracle-CPQ-Base-URL: $ORACLE_CPQ_BASE_URL" \
  --header "X-Oracle-CPQ-Username: $ORACLE_CPQ_USERNAME" \
  --header "X-Oracle-CPQ-Password: $ORACLE_CPQ_PASSWORD"

Your shell fills in the values, and Claude Code saves them in its own settings for this project only. Add --scope user to use the server in every project.

To share the setup with your team without sharing secrets, add a .mcp.json file at the project root instead. Claude Code reads the values from each person's environment variables:

{
  "mcpServers": {
    "cpq-devkit-oracle": {
      "type": "http",
      "url": "https://app.cpqdevkit.com/mcp/oracle",
      "headers": {
        "X-API-Key": "${CPQDEVKIT_API_KEY}",
        "X-Oracle-CPQ-Base-URL": "${ORACLE_CPQ_BASE_URL}",
        "X-Oracle-CPQ-Username": "${ORACLE_CPQ_USERNAME}",
        "X-Oracle-CPQ-Password": "${ORACLE_CPQ_PASSWORD}"
      }
    }
  }
}

Run claude mcp list to check the server is connected, or type /mcp in a Claude Code session. Claude Code asks you to approve servers from a project .mcp.json the first time.

Cursor

Create .cursor/mcp.json in your project, or ~/.cursor/mcp.json in your home folder to use the server in every project:

{
  "mcpServers": {
    "cpq-devkit-oracle": {
      "url": "https://app.cpqdevkit.com/mcp/oracle",
      "headers": {
        "X-API-Key": "${env:CPQDEVKIT_API_KEY}",
        "X-Oracle-CPQ-Base-URL": "${env:ORACLE_CPQ_BASE_URL}",
        "X-Oracle-CPQ-Username": "${env:ORACLE_CPQ_USERNAME}",
        "X-Oracle-CPQ-Password": "${env:ORACLE_CPQ_PASSWORD}"
      }
    }
  }
}

Cursor fills in ${env:…} from your environment, so set the variables in your shell profile and restart Cursor. Then open Cursor Settings, find the MCP section and check that cpq-devkit-oracle shows its tools.

GitHub Copilot in VS Code

Most VS Code users don't need this section: the extension sets the server up for you, as described in “Simplest path: VS Code” above. Use a manual setup if you don't want to install the extension, or to connect to a different site than the extension's active environment.

Create .mcp.json at your workspace root:

{
  "mcpServers": {
    "cpq-devkit-oracle": {
      "type": "http",
      "url": "https://app.cpqdevkit.com/mcp/oracle",
      "headers": {
        "X-API-Key": "${CPQDEVKIT_API_KEY}",
        "X-Oracle-CPQ-Base-URL": "${ORACLE_CPQ_BASE_URL}",
        "X-Oracle-CPQ-Username": "${ORACLE_CPQ_USERNAME}",
        "X-Oracle-CPQ-Password": "${ORACLE_CPQ_PASSWORD}"
      },
      "tools": ["*"]
    }
  }
}

For a setup that applies to every workspace, put the same mcpServers entry in ~/.copilot/mcp-config.json. VS Code reads ${NAME} values from the environment VS Code was started in, so set the variables first and then start VS Code. Older setups used .vscode/mcp.json with a servers key; VS Code now recommends .mcp.json for new configurations.

To check the server, open the tools picker in the Chat view and make sure the server and its tools are selected.

Example prompts

These prompts use read tools, which work on the Free plan:

  1. "List the data tables on my Oracle CPQ site."
  2. "Show the rows of the PartPricing data table where the part number contains SRV."
  3. "Which price books are set up on my site?"

These prompts use agent tools, which need a Pro plan:

  1. "List the BML util library functions on my Oracle CPQ site, grouped by folder."
  2. "Get the util function calculateDiscount and review it for BMQL queries inside loops and calls to functions that don't exist."

Replace the function and table names with ones from your site. To check the connection first, ask the agent to list your data tables: if it answers with tables from your site, the server is connected. On a Pro plan you can also ask "Which Oracle CPQ site is the CPQ DevKit MCP server connected to?" The agent answers with the site address and sign-in method, never with passwords or tokens.

What needs Pro

Read tools, such as the ones for data tables, parts, price books, commerce setup and users, are free within a monthly limit: 100 calls a month on the Free plan and 10,000 on Pro. Each tool your agent runs is one call; connecting and listing tools are not counted.

These tools need a Pro plan:

  • Write tools: create_transaction, perform_action, bulk_transaction_actions, generate_document, create_migration_package, export_migration_package, copy_migration_package, version_migration_package, migrate_package, create_snapshot, revert_to_snapshot, rollback_migration, create_full_backup, create_full_snapshot
  • Bulk tools: get_all_data_table_data, get_all_endpoint_data, get_openapi_spec, get_performance_logs, get_performance_log
  • Agent tools: describe_environment, list_bml_functions, get_bml_function, list_bml_folders, list_integrations, review_bml. They let your agent browse and review BML functions and describe the connected site.

On the Free plan, the server answers these tools with a message that Pro is required, and nothing is sent to your site. Write tools change your Oracle CPQ site, so review what the agent plans to do before you approve a call.

Troubleshooting

  • "Please provide an API key": the X-API-Key header is missing. Check that the environment variable is set in the environment your editor or terminal started from.
  • "Missing required Oracle CPQ headers": add X-Oracle-CPQ-Base-URL and either a user name and password or an access token.
  • "The provided API key is invalid or expired": create a new key at app.cpqdevkit.com and update your environment variable.
  • "Monthly usage limit reached": you have used this month's calls for your plan.

Questions or problems? Write to sales@cpqdevkit.com. See the privacy policy for how we handle data.