Skip to main content
Glama
OpenSIPS

OpenSIPS MCP Server

Official
by OpenSIPS

subscriber_bulk_export

Export subscriber data as CSV from OpenSIPS. Apply optional domain filter, set row limit up to 5000, and control HA1 credential inclusion to protect sensitive material.

Instructions

Dump subscribers as CSV text.

Parameters

domain: Optional domain filter. include_ha1: When True, include the ha1 digest column. Defaults to False — credential material should not leave the DB by accident. limit: Row cap (default and max: 5000).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
domainNo
include_ha1No
limitNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations exist, so the description carries the full burden. It discloses the default for include_ha1 and warns about credential material, and specifies the limit default and maximum. This adds behavioral context beyond the schema. However, it doesn't mention idempotency, rate limits, or side effects (though it's a read operation).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise: a one-line summary followed by a structured parameters section. Each parameter is explained in one line with relevant defaults and warnings. No redundant information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's simplicity (3 parameters, an output schema exists), the description covers all essential aspects: input parameters, their defaults, a security warning, and the output format (CSV text). It is complete enough for an agent to use correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description compensates fully by explaining each parameter: domain (optional filter), include_ha1 (default false, security warning), limit (default and max 5000). This adds significant meaning beyond the plain schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'Dump subscribers as CSV text,' specifying both the action (dump) and the output format (CSV). This distinguishes it from sibling tools like subscriber_list (likely JSON) and subscriber_bulk_import (import).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides some context (optional domain filter, security warning for include_ha1, limit cap) but does not explicitly explain when to use this tool versus alternatives like subscriber_list or subscriber_get. The usage is implied but not contrasted.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/OpenSIPS/opensips-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server