Skip to content

[Enh]: Add parameter description (metadata) #2835

@JerryNixon

Description

@JerryNixon

What?

Expand the stored procedure parameter definition in the configuration file to support richer metadata.
Move from a dictionary mapping of parameter names to values, to an array of parameter objects with explicit fields.

Why?

Supports metadata for each parameter, especially description for MCP.

How?

  • Change the type for the parameters property in the config to an array of objects. (support old syntax too!)
  • Update the JSON schema to support the new structure.
  • Update the internal model to support the new structure.
  • Add parameter name to dab add.
  • Add parameter alias to dab add.
  • Add parameter required to dab add.
  • Add parameter default to dab add.
  • Add parameter name to dab update.
  • Add parameter alias to dab update.
  • Add parameter required to dab update.
  • Add parameter default to dab update.
  • Add support for the expanded parameter object in the CLI dab validate including deprecation notes
  • Include parameter description in DAB's OpenAPI output.
  • Include parameter description in DAB's GraphQL schema output.
  • Update MCP tooling to use the expanded format.

Details

Before
parameters is a dictionary:

{
  "entities": {
    "{entity-name}": {
      "source": {
        "parameters": {
          "parameter-name": "default-value"
        }
      }
    }
  }
}

After
parameters is an array of objects:

Image

Command Line

dab add User --parameters "Id" --required true
dab add User --parameters "Id" --description "My description"
dab add User --parameters "Id" --default "My value"

dab update User --parameters "Id" --required true
dab update User --parameters "Id" --description "My description"
dab update User --parameters "Id" --default "My value"

Metadata

Metadata

Assignees

Labels

mcp-servermssqlan issue thats specific to mssql

Projects

Status

Done

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions