Query accounting CDRs with optional date range and caller/callee filters.

Parameters

date_from: ISO-format start date/time filter (e.g. 2025-01-01T00:00:00). date_to: ISO-format end date/time filter. caller: Partial match on the caller field. callee: Partial match on the callee field.

Query missed calls with optional date range and caller/callee filters.

Parameters

date_from: ISO-format start date/time filter (e.g. 2025-01-01T00:00:00). date_to: ISO-format end date/time filter. caller: Partial match on the caller field. callee: Partial match on the callee field.

Get an AVP value (global scope only — per-transaction AVPs are not MI-accessible).

Parameters

name: AVP name (e.g. $avp(my_var) — pass as my_var).

Set an AVP value in the global scope.

Delete a global AVP.

List active B2B logic sessions (entity keys, state, legs).

List raw B2B entities (UAC/UAS/server) tracked by b2b_entities.

Terminate a B2B session by its entity key.

Parameters

key: The B2B session key as reported by b2b_list_sessions.

Bridge an existing B2B call to a new destination URI.

Useful for attended-transfer, failover, and music-on-hold scenarios.

Parameters

key: Session key from b2b_list_sessions. new_dst: Target SIP URI to bridge to (e.g. sip:agent@domain).

Trigger a B2B scenario by id (defined in b2b_logic XML scenarios).

Parameters

scenario_id: Scenario id from the b2b_logic configuration. custom_hdrs: Optional custom SIP headers for the scenario invocation. params: Optional semicolon-delimited parameters (per-scenario).

List active Shared Call Appearance (SCA) subscriptions.

Run a SIPp REGISTER load test against TARGET.

Captures pre/post snapshots of the proxy's state so the run is self-documenting. Default: 50 CPS for 30 s = 1500 registers, safe for any non-toy proxy.

Parameters

target: host:port of the proxy under test. cps: Calls per second. Capped at 1000. duration_sec: Test duration. Capped at 600 (10 min). out_dir: Directory for the bench artefact JSON. Must be in safe allowlist. label: Optional human tag (baseline, after-tune-shm, ...).

Run a SIPp INVITE load test against TARGET.

Same shape as bench_quick_register but exercises the call path instead of the registration path.

Aggregate every bench artefact in OUT_DIR into one summary.

Useful at the end of a tuning run: bench_summary produces a table of (label, kind, CPS, success_rate, p50/p95 latency, shmem delta) so you can see which knobs actually moved the needle.

List all calls currently queued in the call center.

List all call center agents and their current state.

Log a call center agent in or out.

Parameters

agent_id: The agent identifier (e.g. agent1). state: Login state: 1 to log in, 0 to log out.

Reload call center agents and flows from the database.

Get a combined call center status: queue, agents, and flows.

Returns all three datasets in a single response for a complete overview of the call center state.

Reload carrier route tables from the database.

Dump loaded carrier route tables (carriers, domains, prefixes, hosts).

Activate a carrier route host (return to service).

Use this after maintenance to re-enable a previously deactivated gateway.

Deactivate a carrier route host (drain, take out of service).

Replace a host in carrier route (e.g. IP change).

Does not require a reload; applies at runtime.

Scan the acc table for gaps, duplicates, and duration anomalies.

Parameters

date_from, date_to: ISO timestamps bounding the audit window. Window is capped at 31 days; longer ranges should go through a warehouse / BI tool. max_gap_sec: Gap between consecutive CDRs that counts as a suspicious silence. Default 300s (5 min). long_call_threshold_sec: Duration above which a call is flagged as a potential stuck dialog. Default 14400s (4h).

Volume and success-code breakdown over a window.

Parameters

date_from, date_to: ISO timestamps bounding the report window. group_by: hour or day. Grouping is computed in Python so it works across sqlite / mysql / postgres without backend-specific SQL.

Count CDRs by SIP response code within a window.

Quick-glance "what's the 5xx rate right now?" report — SQL-side aggregation so it is cheap even on large acc tables.

Generate an OpenSIPS configuration from a predefined scenario template.

Renders the scenario template, then — by default — runs opensips -C -f when the binary is on PATH and runs the static linter unconditionally. The Summit deck claim "Every output runs through opensips -C -f" lives here: this is the headline tool, and it owns the validate-on-render contract. If the binary is unavailable, the result includes validation: {"skipped": true, "reason": "opensips binary not found"} so the caller can decide whether to proceed.

Parameters

scenario: Name of the scenario (e.g. load_balancer, class4_sbc, registrar_class5, webrtc_gateway, residential_pbx, call_center, b2bua, sbc_with_rtpengine). params: Template parameters such as db_url, listen_ip, domain, etc. validate: When True (default), run opensips -C -f against the rendered cfg. Skipped (with a reason) if the binary is not on PATH. lint: When True (default), run cfg_lint against the rendered cfg and surface findings + suggestions. Pure Python, always available.

Validate an OpenSIPS configuration by running opensips -C -f.

Parameters

config_content: The full OpenSIPS configuration text to validate.

Parse an OpenSIPS configuration and extract its structure.

Returns modules, modparams, listen addresses, routes, and global params.

Parameters

config_content: The full OpenSIPS configuration text to parse.

List all available OpenSIPS configuration scenarios with descriptions.

Get required and optional parameters for a configuration scenario.

Parameters

scenario: The scenario name (e.g. load_balancer).

Compute a unified diff between two OpenSIPS configurations.

Parameters

config_a: The first (original) configuration text. config_b: The second (modified) configuration text.

Explain an OpenSIPS route block by identifying its components.

Analyzes the route code and identifies SIP methods handled, module functions called, conditions, and overall flow.

Parameters

route_code: The route block code to explain (e.g. the body of a route{...}).

Add a module (with optional modparams) to an existing OpenSIPS configuration.

Inserts the loadmodule directive and any modparam lines after the last existing loadmodule or modparam block.

Parameters

config_content: The existing OpenSIPS configuration text. module_name: The module to add (e.g. dispatcher, rtpengine). params: Optional dict of {param_name: value} to set via modparam.

Analyze an OpenSIPS configuration and suggest optimizations.

Checks for common issues: missing modules, redundant settings, performance tuning opportunities, and security recommendations.

Parameters

config_content: The OpenSIPS configuration text to analyze.

Generate an OpenSIPS config and iteratively validate it.

Generates a configuration from the given scenario, validates it using opensips -C -f, and reports the results. If validation fails, the raw output is included for diagnosis.

Parameters

scenario: The scenario template name. params: Template parameters. max_attempts: Maximum validation attempts (reserved for future auto-fix logic).

Start an interactive m4 config-building session.

Takes a natural-language description (e.g. "I need a SIP load balancer for 4 backends") and returns the suggested scenario, required site parameters with descriptions, optional parameters, and a next-step instruction for the LLM.

Parameters

description: Natural-language description of the deployment the user wants.

Render the m4 template pair (main + local) for a scenario.

The returned strings are intended to be persisted to opensips.cfg.m4 and local.cfg.m4 respectively, then preprocessed with m4.

Parameters

scenario: Scenario name (load_balancer, class4_sbc, registrar_class5, webrtc_gateway, base). template_params: Structural/Jinja2 template knobs (e.g. include_usrloc for base). site_params: Dict of m4 defines that will appear in local.cfg.m4 (e.g. {"LISTEN": "udp:10.0.0.5:5060", "DB_URL": "mysql://..."}).

Run m4 local.cfg.m4 opensips.cfg.m4 and optionally validate the output.

Parameters

main_m4: Contents of opensips.cfg.m4. local_m4: Contents of local.cfg.m4 (site-specific define(...) lines). validate: If True and the opensips binary is present, run opensips -C -f on the preprocessed output.

Safely iterate on a config: preprocess + validate, write nothing.

Intended as the LLM's tight feedback loop while building or editing a config — call this between successive renders to verify correctness before asking the user to save.

Parameters

main_m4: Contents of opensips.cfg.m4. local_m4: Contents of local.cfg.m4.

Validate an edited OpenSIPS config and return a unified diff.

Does not write anything to disk — the caller chooses to persist after reviewing the diff.

Parameters

existing_cfg: The current on-disk configuration text. change_description: Short natural-language description of the intended change (e.g. "Increase children to 16 and enable TLS"). new_cfg: The LLM's rewritten configuration text.

Diagnostic: check whether the m4 binary is available on the host.

Returns path, version, and availability status.

Persist the m4 pair to disk, optionally also writing the preprocessed cfg.

Writes {out_dir}/opensips.cfg.m4 and {out_dir}/local.cfg.m4. When write_preprocessed is True, also runs m4 and writes {out_dir}/opensips.cfg.

The output directory is validated — writes to system directories such as /, /etc, /usr, /bin are rejected.

Parameters

out_dir: Directory that will receive the files. Created if missing. main_m4: Contents for opensips.cfg.m4. local_m4: Contents for local.cfg.m4. write_preprocessed: If True, also run m4 and write opensips.cfg.

List supported OpenSIPS versions and the chain of migration hops.

Returns the known versions (from the migration rule tables) and the summary of each hop (2.4 → 3.0 → ... → 4.0). Use this before calling :func:cfg_migrate to confirm your source and target are supported.

Report what a version migration would do, without rewriting the config.

Terraform-plan equivalent. Returns the ordered list of hops, every automatic rewrite, and every manual step / silent-gotcha warning.

Parameters

config_content: The current OpenSIPS configuration text. from_version: Current OpenSIPS version (e.g. 3.4). to_version: Target OpenSIPS version (e.g. 3.6).

Migrate a configuration between OpenSIPS versions.

Walks the hop chain (2.4 → 3.0 → ... → 4.0) applying every behaviour-preserving rewrite rule. Anything that cannot be safely auto-applied is reported as a warning — the engineer must apply those manually.

When validate is true and an opensips binary is available, the migrated config is also run through opensips -C -f.

Parameters

config_content: The current OpenSIPS configuration text. from_version: Current OpenSIPS version. to_version: Target OpenSIPS version. validate: Run the migrated config through opensips -C when available.

Check a config for incompatibilities with a target OpenSIPS version.

Reports modules that don't exist in the target version, deprecated parameters, and silent-gotcha defaults. Pairs well with :func:cfg_migrate_plan — run compat first to learn about removals, plan next to see the rewrites.

Parameters

config_content: The OpenSIPS configuration text to check. target_version: The version you intend to run this config on.

Run the OpenSIPS semantic linter against a configuration.

Checks module dependencies, orphaned modparams, deprecated parameters, missing mf_process_maxfwd_header, anti-flood absence, NAT/rtpengine dependency gaps, and other common production pitfalls.

Parameters

config_content: The OpenSIPS configuration text to lint. include: Optional allow-list of rule ids (e.g. ["OPS001", "OPS004"]). exclude: Optional deny-list of rule ids.

Return all available lint rule ids.

Generate a PGTune-style capacity-tuned override snippet.

Ask the user five questions about their workload, return a small paste-ready set of overrides with a # why: comment on every line. Intended to be merged into an existing opensips.cfg — it is NOT a full configuration.

Parameters

role: One of edge, registrar, lb, b2bua, sbc, presence, generic. cpu_cores: Physical or allocated CPU cores. memory_mb: RAM in megabytes available to OpenSIPS. cps: Expected peak calls per second. concurrent_calls: Expected peak concurrent calls. tls: True if TLS / WSS traffic is significant. nat: True if the deployment handles heavy NAT'd clients. ha: True if deployed active-active / clustered. registrations: Expected concurrent registered AoRs (registrar role).

Explain an OpenSIPS directive, module, function, or pseudo-variable.

kubectl explain equivalent. Accepts flexible topic syntax:

• dialog — module overview

• dialog.db_mode — specific modparam

• record_route — script function

• $ru — pseudo-variable

• listen — global parameter

• lb_status — MI command (with version-rename history)

Parameters

topic: The directive / name to explain.

List all available WITH_* feature flags.

The flag vocabulary is Kamailio-compatible so engineers migrating between the two projects keep the same mental model.

Resolve a set of WITH_* flags into modules and globals.

Does NOT produce a config — it answers the question "if I enable these flags, what modules get loaded and which globals get set?". Pairs with :func:cfg_build_from_flags for the full render.

Parameters

flags: List of WITH_* flag names (case-insensitive).

Build a flat opensips.cfg from a set of WITH_* flags.

Materialises the Kamailio-style flag vocabulary as a flat, no-#!ifdef OpenSIPS config. Only the enabled blocks are inlined, so the output reads cleanly without the nested-ifdef problem Kamailio users hit.

Parameters

flags: Any combination of WITH_* flags (see cfg_list_flags). site_params: Optional site values (LISTEN, DB_URL, TLS_CERT_PATH, TLS_KEY_PATH, RTP_PROXY_ADDR, CHILDREN). validate: Run the result through opensips -C when available.

List modules from the OpenSIPS module catalog.

Used by the wizard and by LLMs that need to check whether a module is available in a given version.

Parameters

version: Filter to modules available in this OpenSIPS version (e.g. 3.6). category: Filter by category (core, transport, tls, db, routing, auth, media, security, nat, ...).

Compare a config against the reference output for a scenario.

Shows which parts of the config are "custom" (differ from the canned scenario template). Useful for reviewing what your team has diverged on and would need to re-apply after upgrading the reference template.

Parameters

config_content: The OpenSIPS configuration text to compare. scenario: The reference scenario name (see cfg_list_scenarios). params: Parameters used to render the reference.

Copy config_path to a timestamped backup in a safe directory.

The backup name is <basename>.bak-YYYYMMDD-HHMMSS next to the original (or in backup_dir when provided). Returns the backup path so the caller can pass it to cfg_rollback later.

Parameters

config_path: Absolute path of the existing config file. Must live in an allowlisted directory (/tmp, /var/tmp, or $HOME; override with OPENSIPS_MCP_OUT_DIR_ROOT). backup_dir: Optional destination directory for the backup copy. Default: alongside the original file.

List available .bak-* backups for config_path.

Parameters

config_path: Absolute path whose backups we want to enumerate. The basename is used as the prefix filter. backup_dir: Optional directory to search. Defaults to the directory of config_path.

Restore backup_path to target_path and re-validate.

Before overwriting, the current contents of target_path (if any) are themselves backed up so this tool is always reversible one more step. If validate_after=True, the restored config is passed through opensips -C; a validation failure does NOT undo the restore (the caller asked for the restore explicitly), but the result is surfaced so the caller can decide what to do next.

Parameters

backup_path: Absolute path to the backup file to restore. target_path: Absolute path to overwrite. Must live in an allowlisted dir. validate_after: Run opensips -C on the restored file. Default True.

List all cluster nodes and their current status.

Show the cluster topology — how nodes are interconnected.

Send an MI command to a specific node in the cluster.

Parameters

cluster_id: The cluster ID. node_id: The target node ID within the cluster. mi_cmd: The MI command to execute on the remote node. Must be registered in :data:MI_COMMANDS; the per-command permission is enforced so this tool cannot be used to bypass mi.write controls. mi_params: Optional parameters for the MI command (JSON string).

Gracefully drain a cluster node ahead of maintenance.

Marks the node as disabled in the clusterer, then polls the local dialog count until it stops declining or the timeout fires. The caller is expected to stop the OpenSIPS process only after this tool confirms the dialog backlog is low.

This tool operates on the cluster metadata — it does NOT shut OpenSIPS down. Combine with your init-script / systemd unit to actually stop the service.

Parameters

cluster_id: Target cluster ID. node_id: Target node ID within the cluster. timeout_sec: Maximum time to wait for dialogs to drain. Clamped to 5..600. poll_interval_sec: Seconds between dialog-count samples. Clamped to 1..60.

Bring a disabled cluster node back into active service.

Counterpart to cluster_drain_node: flips status back to OK so peers resume sending traffic / replication to the node.

Report cluster sync health: capabilities, sharing tags, topology.

Combines clusterer_list, clusterer_list_cap and clusterer_list_shtags into one view so an operator can answer "is replication healthy across all nodes?" from a single call.

Dump table to a timestamped JSON file under out_dir.

Parameters

table: One of the supported OpenSIPS data tables (subscriber, dispatcher, address, drouting_rule, drouting_gateway, drouting_carrier, dialplan, load_balancer, domain, tls_mgm). out_dir: Directory to write into. Must be in the safe allowlist. label: Optional tag (e.g. before-bulk-import) added to the filename.

List backup files for table under out_dir, newest first.

Restore a table from a JSON backup produced by db_table_backup.

By default this is a dry-run. Pass confirm=True to actually write. Pass truncate_first=True to delete every existing row in the table BEFORE inserting the backup — needed when the backup is intended to fully replace current state, but dangerous if you misjudge the scope.

Parameters

backup_path: Path to the JSON file produced by db_table_backup. confirm: Must be True to write. Default False returns the plan. truncate_first: If True, delete current rows before inserting from the backup. Use when restoring a complete table snapshot.

List all running OpenSIPS processes with their PID and description.

Show OpenSIPS memory usage details (shared and private memory).

Show how long the OpenSIPS instance has been running.

List all active TCP and TLS connections.

Show the version string of the connected OpenSIPS instance.

List active SIP dialogs.

Parameters

callid: Optional Call-ID to filter by a specific dialog. from_tag: Optional From-tag to further narrow the dialog lookup.

End (tear down) an active dialog.

Parameters

callid: The Call-ID of the dialog to terminate. from_tag: The From-tag of the dialog. to_tag: The To-tag of the dialog.

Get dialog profile information.

Parameters

profile: Specific profile name to query size for. If omitted, lists all profiles.

Push a variable into an active dialog.

Parameters

callid: The Call-ID of the target dialog. from_tag: The From-tag of the target dialog. var_name: Name of the dialog variable to set. var_value: Value to assign to the variable.

List dialplan rules, optionally filtered by dialplan id.

Add a dialplan translation rule.

Parameters

dpid: Dialplan id (translation table id, referenced from script). match_op: Match operator — 0 = equal, 1 = regex (default), 2 = fnmatch. match_exp: Pattern to match against the input. subst_exp: Substitution regex (for match_op=1). repl_exp: Replacement string. pr: Priority — lower matches first.

Update a dialplan rule by id.

Delete a dialplan rule by id.

Reload dialplan rules from the database (triggers MI dp_reload).

Test a dialplan translation without dispatching a call.

Parameters

dpid: Dialplan table id. input: Input string to translate (e.g. +14155551212).

Returns

The translated output string and matching rule metadata.

List dispatcher destinations from the database, optionally filtered by set ID.

Add a new dispatcher destination. Optionally triggers MI ds_reload.

Update a dispatcher destination by ID. Optionally triggers MI ds_reload.

Remove a dispatcher destination by ID. Optionally triggers MI ds_reload.

List all available Docker deployment scenarios.

Returns the scenario names and their docker-compose file paths.

Return the docker-compose command to deploy a specific scenario.

Parameters

scenario: Name of the scenario directory (e.g. load-balancer, class4-sbc).

Show the status of running Docker Compose services.

Executes docker compose ps and returns the output.

Retrieve recent logs from a Docker Compose service.

Parameters

service: The service name to fetch logs for (default: opensips). lines: Number of recent log lines to return (default: 100).

Restart a Docker Compose service.

Parameters

service: The service name to restart (default: opensips).

List all locally-served SIP domains.

Add a new SIP domain to the database.

Delete a SIP domain from the database.

Reload the domain table in OpenSIPS via MI command.

List dynamic routing rules, optionally filtered by group or prefix.

Add a new dynamic routing rule. Optionally triggers MI dr_reload.

List dynamic routing gateways.