Skip to main content

Optuna MCP Server operates, manages, and visualizes Optuna studies.

Project description

Optuna MCP Server

Python pypi GitHub license Tests

A Model Context Protocol (MCP) server that automates optimization and anlysis using Optuna.

image

Use Cases

The Optuna MCP Server can be used in the following use cases, for example.

  • Automated hyperparameter optimization by LLMs
  • Interactive analysis of Optuna's optimization results via chat interface
  • Optimize input and output of other MCP tools

For details, see the Examples section.

Installation

The Optuna MCP server can be installed using uv or Docker. This section explains how to install the Optuna MCP server, using Claude Desktop as an example MCP client.

Usage with uv

Before starting the installation process, install uv from Astral.

Then, add the Optuna MCP server configuration to the MCP client. To include it in Claude Desktop, go to Claude > Settings > Developer > Edit Config > claude_desktop_config.json and add the following:

{
  "mcpServers": {
    "Optuna": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/optuna/optuna-mcp",
        "optuna-mcp"
      ]
    }
  }
}

Additionally, you can specify the Optuna storage with the --storage argument to persist the results.

{
  "mcpServers": {
    "Optuna": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/optuna/optuna-mcp",
        "optuna-mcp"
        "--storage",
        "sqlite:///optuna.db"
      ]
    }
  }
}

After adding this, please restart Claude Desktop application. For more information about Claude Desktop, check out the quickstart page.

Usage with Docker

You can also run the Optuna MCP server using Docker. Make sure you have Docker installed and running on your machine.

{
  "mcpServers": {
    "Optuna": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "--net=host",
        "-v",
        "/PATH/TO/LOCAL/DIRECTORY/WHICH/INCLUDES/DB/FILE:/app/workspace",
        "optuna/optuna-mcp:latest",
        "--storage",
        "sqlite:////app/workspace/optuna.db"
      ],
    }
  }
}

Tools provided by Optuna MCP

The Optuna MCP provides the following tools. Specifically, it offers primitive functions of Optuna such as Study, Trial, Visualization, and Dashboard. Since MCP clients know the list of tools and the details of each tool, users do not need to remember those details.

Study

  • create_study - Create a new Optuna study with the given study_name and directions. If the study already exists, it will be simply loaded.
    • study_name : name of the study (string, required).
    • directions: The directions of optimization (list of literal strings minimize/maximize, optional).
  • set_sampler - Set the sampler for the study.
    • name : the name of the sampler (string, required).
  • get_all_study_names - Get all study names from the storage.
  • set_metric_names - Set metric_names. Metric_names are labels used to distinguish what each objective value is.
    • metric_names : The list of metric names for each objective (list of strings, required).
  • get_metric_names - Get metric_names.
    • No parameters required.
  • get_directions - Get the directions of the study.
    • No parameters required.
  • get_trials - Get all trials in a CSV format.
    • No parameters required.
  • best_trial - Get the best trial.
    • No parameters required.
  • best_trials - Return trials located at the Pareto front in the study.
    • No parameters required.

Trial

  • ask - Suggest new parameters using Optuna.
    • search_space : the search space for Optuna (dictionary, required).
  • tell - Report the result of a trial.
    • trial_number : the trial number (integer, required).
    • values : the result of the trial (float or list of floats, required).
  • set_trial_user_attr - Set user attributes for a trial.
    • trial_number: the trial number (integer, required).
    • key: the key of the user attribute (string, required).
    • value: the value of the user attribute (any type, required).
  • get_trial_user_attrs - Get user attributes in a trial.
    • trial_number: the trial number (integer, required).

Visualization

  • plot_optimization_history - Return the optimization history plot as an image.
    • target: index to specify which value to display (integer, optional).
    • target_name: target’s name to display on the axis label (string, optional).
  • plot_hypervolume_history - Return the hypervolume history plot as an image.
    • reference_point : a list of reference points to calculate the hypervolume (list of floats, required).
  • plot_pareto_front - Return the Pareto front plot as an image for multi-objective optimization.
    • target_names: objective name list used as the axis titles (list of strings, optional).
    • include_dominated_trials: a flag to include all dominated trial's objective values (boolean, optional).
    • targets: a list of indices to specify the objective values to display. (list of integers, optional).
  • plot_contour - Return the contour plot as an image.
    • params : parameter list to visualize (list of strings, optional).
    • target : an index to specify the value to display (integer, required).
    • target_name : target’s name to display on the color bar (string, required).
  • plot_parallel_coordinate - Return the parallel coordinate plot as an image.
    • params : parameter list to visualize (list of strings, optional).
    • target : an index to specify the value to display (integer, required).
    • target_name : target’s name to display on the axis label and the legend (string, required).
  • plot_slice - Return the slice plot as an image.
    • params : parameter list to visualize (list of strings, optional).
    • target : an index to specify the value to display (integer, required).
    • target_name : target’s name to display on the axis label (string, required).
  • plot_param_importances - Return the parameter importances plot as an image.
    • params : parameter list to visualize (list of strings, optional).
    • target : an index to specify the value to display (integer/null, optional).
    • target_name : target’s name to display on the legend (string, required).
  • plot_edf - Return the EDF plot as an image.
    • target : an index to specify the value to display (integer, required).
    • target_name : target’s name to display on the axis label (string, required).
  • plot_timeline - Return the timeline plot as an image.
    • No parameters required.
  • plot_rank - Return the rank plot as an image.
    • params : parameter list to visualize (list of strings, optional).
    • target : an index to specify the value to display (integer, required).
    • target_name : target’s name to display on the color bar (string, required).

Web Dashboard

  • launch_optuna_dashboard - Launch the Optuna dashboard.
    • port: server port (integer, optional, default: 58080).

Examples

Optimizing the 2D-Sphere Function

Here we present a simple example of optimizing the 2D-Sphere function, along with example prompts and the summary of the LLM responses.

User prompt Output in Claude
(Launch Claude Desktop) 1
Please create an Optuna study named "Optimize-2D-Sphere" for minimization. 2
Please suggest two float parameters x, y in [-1, 1]. 3
Please report the objective value x**2 + y**2. To calculate the value, please use the JavaScript interpreter and do not round the values. 4
Please suggest another parameter set and evaluate it. 5
Please plot the optimization history so far. 6

Starting the Optuna Dashboard and Analyzing Optimization Results

You can also start the Optuna dashboard via the MCP server to analyze the optimization results interactively.

User prompt Output in Claude
Please launch the Optuna dashboard. 7

By default, the Optuna dashboard will be launched on port 58080. You can access it by navigating to http://localhost:58080 in your web browser as shown below: 8

Optuna dashboard provides various visualizations to analyze the optimization results, such as optimization history, parameter importances, and more.

Optimizing the FFmpeg Encoding Parameters

ffmpeg-2

This demo showcases how to use the Optuna MCP server to automatically find optimal FFmpeg encoding parameters. It optimizes x264 encoding options to maximize video quality (measured by the SSIM score) while keeping encoding time reasonable.

Check out examples/ffmpeg.md for details.

Optimizing the Cookie Recipe

cookie-recipe

In this example, we will optimize a cookie recipe, referencing the paper titled "Bayesian Optimization for a Better Dessert".

Check out examples/cookie-recipe for details.

License

MIT License (see LICENSE).

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

optuna_mcp-0.1.2.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

optuna_mcp-0.1.2-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file optuna_mcp-0.1.2.tar.gz.

File metadata

  • Download URL: optuna_mcp-0.1.2.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for optuna_mcp-0.1.2.tar.gz
Algorithm Hash digest
SHA256 9c742afc3c3b1de402f73595cd2641f15687131b597d896882c3ecc04eb3a742
MD5 68e3ad3c237a8a663087d47222a56eae
BLAKE2b-256 f8eabf4631e8627dd414b0bbca9a4ee664974045ff5b106ef4352850c9540fbe

See more details on using hashes here.

File details

Details for the file optuna_mcp-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: optuna_mcp-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 10.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for optuna_mcp-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6cc5574715520f302c33e1f58bd9c5dde5a4957f12c24a0ca7acc744e55bff63
MD5 d9ee5a4f70f0ed37437071e8f3106a05
BLAKE2b-256 27827b4a7310c220e5d4589070a812a4ff55f4e8fce750cbe829328af55b7ad7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page