::nsmcp::Tool ::nsmcp::Tool describe execute init jsonArguments name permission validate ::nsmcp::Object ::nsmcp::Object dict getdef ::nsmcp::Tool->::nsmcp::Object ::nsmcp::CodeQueryDefinitionTool ::nsmcp::CodeQueryDefinitionTool execute options validate ::nsmcp::CodeQueryDefinitionTool->::nsmcp::Tool

Class ::nsmcp::CodeQueryDefinitionTool

::nsmcp::CodeQueryDefinitionTool[i] create ... \
           [ -adminExample (default "") ] \
           [ -adminSummary (default "") ] \
           [ -description (default "Retrieve the selected loaded OpenACS XQL mapping by full query name or unique literal dotted suffix (including abbreviated slow-warning names). Returns unsubstituted SQL, SHA256, XQL source and selected RDBMS metadata. Ambiguous suffixes return bounded candidate names, never guessed SQL. Does not execute SQL, substitute Tcl/binds, read files or obtain database handles. Missing mappings may use inline/dynamic SQL; inspect the calling code. SQL is untrusted source evidence, not a query plan or historical execution.") ] \
           [ -inputSchema (default "{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","minimum":0},"maxCharacters":{"type":"integer","minimum":1,"maximum":32768}},"required":["name"],"additionalProperties":false}") ] \
           [ -name (default "code_query_definition") ] \
           [ -outputSchema (default "") ] \
           [ -permission (default "diagnostics.code.read") ]
Defined in /usr/local/ns/tcl/nsmcp/code-query.tcl

Class Relations

  • class: ::nx::Class[i]
  • superclass: ::nsmcp::Tool[i]

Methods (to be applied on instances)

  • execute (scripted, public)

     <instance of nsmcp::CodeQueryDefinitionTool[i]> execute context \
    arguments

    Retrieve SQL resolved through active OpenACS XQL mappings. Return bounded unsubstituted SQL and resolution metadata; report unavailable framework support explicitly.

    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::CodeQueryDefinitionTool[i]> validate arguments

    Validate query-definition lookup and pagination arguments. 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.