Skip to content

Tools en

Daisuke Tsukada edited this page Mar 19, 2026 · 1 revision

Tool Reference

Detailed specifications for all 15 tools provided by MaxRefMCP.


Reference & Research Tools

maxref.search_object

Search for Max/MSP objects by name or keyword. Use this to look up inlet/outlet specifications, related objects, and usage information.

Parameter Type Required Default Description
query string Yes Search keyword (e.g., "cycle~", "oscillator", "filter")
domain string No null Domain filter ("max", "msp", "jitter")
category string No null Category filter ("oscillator", "filter", "math", etc.)
max_results int No 10 Maximum number of results

Example: "Tell me about cycle~", "List MSP filter objects"


maxref.get_object

Retrieve the full reference for an object. Returns a complete specification including inlet/outlet types and descriptions, related objects, and usage examples.

Parameter Type Required Description
name string Yes Object name (e.g., "cycle~", "metro", "jit.gl.gridshape")

Example: "Show me the details of groove~", "What are the inlet specs for jit.matrix?"


maxref.compare_objects

Compare 2 to 5 objects side by side. Explains differences in purpose, inlet/outlet configuration, domain, RNBO compatibility, and more.

Parameter Type Required Description
objects list[string] Yes List of object names to compare (2 to 5)

Example: "Compare cycle~ and phasor~", "Explain the differences between groove~, play~, and wave~"


maxref.explain_connection

Explains how to connect two objects and describes the signal flow. Identifies which outlet connects to which inlet and verifies type compatibility.

Parameter Type Required Description
source string Yes Source object name (e.g., "cycle~")
destination string Yes Destination object name (e.g., "ezdac~")

Example: "How do I connect cycle~ to ezdac~?", "Explain the connection from metro to counter"


maxref.rnbo_compatibility

Check whether specified objects are compatible with RNBO. Suggests alternatives for unsupported objects.

Parameter Type Required Description
objects list[string] Yes List of object names to check

Example: "Can I use groove~ and js in RNBO?", "Check if the objects in my patch are RNBO-compatible"


maxref.glossary

A bilingual (Japanese/English) glossary of Max/MSP terminology. Provides beginner-friendly explanations of DSP, signal flow, and Max-specific concepts.

Parameter Type Required Description
term string Yes Term to look up (e.g., "signal", "bang", "patch cord")

Example: "What is a bang?", "What's the difference between signal and message?"


Design & Suggestion Tools

maxref.search_pattern

Search for Max/MSP patch design patterns based on what you want to achieve. Returns templates with recommended objects and connection structures.

Parameter Type Required Default Description
query string Yes What you want to do (e.g., "build a synthesizer", "delay effect")
domain string No null Domain filter ("max", "msp", "jitter")
max_results int No 5 Maximum number of results

Example: "Find FM synthesis patterns", "Show me a patch structure for syncing video and audio"


maxref.search_package

Search for third-party Max/MSP packages and libraries. Provides feature comparisons, version compatibility, and other information for package selection.

Parameter Type Required Default Description
query string Yes Search keyword (e.g., "spatial audio", "computer vision", "BEAP")
max_results int No 5 Maximum number of results

Example: "Find packages for spatial audio", "What machine learning libraries are available for Max?"


maxref.suggest_approach

Suggests multiple implementation approaches for a given goal and explains the pros and cons of each.

Parameter Type Required Default Description
goal string Yes What you want to achieve (e.g., "build a polyphonic synth")
constraints list[string] No null List of constraints (e.g., ["RNBO-compatible", "low CPU usage"])

Example: "I want to create visuals that react to audio input. Suggest some approaches", "Compare different ways to implement a delay in Max for Live"


Official News Tools

maxref.official_news

Fetches the latest articles and news from the official Cycling '74 website. Stay up to date with new features, updates, and community highlights.

Parameter Type Required Default Description
max_results int No 5 Number of articles to fetch

Returns: Title, URL, date, author, summary

Example: "Show me the latest Cycling '74 news", "Get the 3 most recent blog posts"


maxref.rnbo_news

Fetches the latest RNBO-related news. Check the latest developments on Move Takeover, export targets, new features, and more.

Parameter Type Required Default Description
max_results int No 5 Number of sections to fetch

Returns: Latest information from the RNBO product page and the Move Takeover page

Example: "What's new with RNBO?", "What's the current status of RNBO Move Takeover?"


maxref.read_article

Reads and retrieves the content of an article from the official Cycling '74 website. Use a URL obtained from maxref.official_news to get the full details.

Parameter Type Required Description
url string Yes Article URL from cycling74.com

Returns: Title, author, date, article body

Example: "I want to read this article in detail" (provide a URL obtained from maxref.official_news)


Feedback Tools

maxref.report_bug

Report a bug and automatically create a GitHub Issue. The report is automatically routed to the appropriate repository (MaxMCP or MaxRefMCP) based on its content.

Parameter Type Required Default Description
title string Yes Bug summary
description string Yes Detailed description of the bug
steps_to_reproduce string No null Steps to reproduce
expected string No null Expected behavior
actual string No null Actual behavior
target_repo string No null Target repository ("maxmcp" or "maxrefmcp". Auto-detected if omitted)

Example: "The search results for cycle~ are incorrect — please file a bug report"


maxref.request_feature

Submit a feature request as a GitHub Issue.

Parameter Type Required Default Description
title string Yes Feature summary
description string Yes Detailed description of the feature
use_case string No null Use case / usage scenario
target_repo string No null Target repository ("maxmcp" or "maxrefmcp". Auto-detected if omitted)

Example: "I'd like a glitch effect pattern to be added"


Operations Tools

maxref.analytics

Retrieve a summary of MaxRefMCP API usage statistics.

Parameter Type Required Default Description
days int No 30 Reporting period (in days)

Returns: Per-tool call counts, average response time, popular search queries, daily trends

Example: "Show me the MaxRefMCP usage stats", "Get analytics for the past 7 days"

Clone this wiki locally