---

Class ::nsmcp::ConfigurationTool

::nsmcp::ConfigurationTool create ... \
           [ -adminExample (default "") ] \
           [ -adminSummary (default "") ] \
           [ -authorizer:required authorizer:required ] \
           [ -description (default "Inspect live NaviServer configuration for configuration reviews, SMTP policy interpretation and scaling advice. scope=server (default) returns process-wide sections plus the authenticated virtual server's sections, excluding other virtual servers. scope=process returns every section across all virtual servers and requires diagnostics.configuration.process.read in addition to diagnostics.runtime.read. Includes driver, database-pool, connection-pool, limit, logging and module settings. Policy scripts are returned as data and are never executed. Named credential values and URI userinfo are redacted; referenced files are not read. Configuration reflects the current configuration table, including defaults published there by modules, not necessarily every compiled default or a historical policy. Use section to select an exact section and its descendants. Follow nextArguments to retrieve remaining sections. Pair with server_topology and server_runtime for actual installed components and utilization.") ] \
           [ -inputSchema (default "
        {
            "type": "object",
            "properties": {
                "scope": {
                    "type": "string",
                    "enum": [
                        "server",
                        "process"
                    ],
                    "default": "server"
                },
                "section": {
                    "type": "string",
                    "description": "Exact section prefix, including descendants; defaults to all authorized sections."
                },
                "limit": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 100,
                    "default": 50
                },
                "offset": {
                    "type": "integer",
                    "minimum": 0,
                    "default": 0
                }
            },
            "additionalProperties": false
        }
    ") ] \
           [ -name (default "configuration") ] \
           [ -outputSchema (default "") ] \
           [ -permission (default "diagnostics.runtime.read") ] \
           [ -redactor:required redactor:required ]

Defined in /usr/local/ns/tcl/nsmcp/config-tools.tcl

Class Relations

• class: ::nx::Class
• superclass: ::nsmcp::Tool

Methods (to be applied on instances)

• execute (scripted, public)

   <instance of nsmcp::ConfigurationTool> execute context arguments

  Read bounded, redacted runtime configuration evidence. Apply the selected process/server/module scope and retain coverage and pagination limitations.

  Parameters:

  context (required)

  Authenticated request context carrying the principal, grants and selected server.

  arguments (required)

  Rooted ns_json typed triples for the tool's JSON argument object.

  Returns:

  A rooted JSON tool-result object, including availability or job metadata as appropriate.

  Testcases:

  No testcase defined.

• validate (scripted, public)

   <instance of nsmcp::ConfigurationTool> validate arguments

  Validate runtime-configuration inspection options. Decode the rooted JSON argument object and enforce this tool's option, range and combination constraints.

  Parameters:

  arguments (required)

  Rooted ns_json typed triples for the tool's JSON argument object.

  Returns:

  An empty result on success; invalid input raises RPC error -32602.

  Testcases:

  No testcase defined.

---