Skip to content

Commit 92c5367

Browse files
committed
feat(commands): add descriptions to command parsers for better clarity
1 parent 7ef57bd commit 92c5367

6 files changed

Lines changed: 6 additions & 0 deletions

File tree

struct_module/commands/generate.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
class GenerateCommand(Command):
1313
def __init__(self, parser):
1414
super().__init__(parser)
15+
parser.description = "Generate the project structure from a YAML configuration file"
1516
structure_arg = parser.add_argument('structure_definition', type=str, help='Path to the YAML configuration file')
1617
structure_arg.completer = structures_completer
1718
parser.add_argument('base_path', type=str, help='Base path where the structure will be created')

struct_module/commands/generate_schema.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
class GenerateSchemaCommand(Command):
77
def __init__(self, parser):
88
super().__init__(parser)
9+
parser.description = "Generate JSON schema for available structures"
910
parser.add_argument('-s', '--structures-path', type=str, help='Path to structure definitions')
1011
parser.add_argument('-o', '--output', type=str, help='Output file path for the schema (default: stdout)')
1112
parser.set_defaults(func=self.execute)

struct_module/commands/info.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
class InfoCommand(Command):
99
def __init__(self, parser):
1010
super().__init__(parser)
11+
parser.description = "Show information about the package or structure definition"
1112
parser.add_argument('structure_definition', type=str, help='Name of the structure definition')
1213
parser.add_argument('-s', '--structures-path', type=str, help='Path to structure definitions')
1314
parser.add_argument('--mcp', action='store_true', help='Enable MCP (Model Context Protocol) integration')

struct_module/commands/list.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
class ListCommand(Command):
1010
def __init__(self, parser):
1111
super().__init__(parser)
12+
parser.description = "List available structures"
1213
parser.add_argument('-s', '--structures-path', type=str, help='Path to structure definitions')
1314
parser.add_argument('--names-only', action='store_true', help='Print only structure names, one per line (for shell completion)')
1415
parser.add_argument('--mcp', action='store_true', help='Enable MCP (Model Context Protocol) integration')

struct_module/commands/mcp.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
class MCPCommand(Command):
99
def __init__(self, parser):
1010
super().__init__(parser)
11+
parser.description = "MCP (Model Context Protocol) support for struct tool"
1112
parser.add_argument('--server', action='store_true',
1213
help='Start the MCP server for stdio communication')
1314
parser.set_defaults(func=self.execute)

struct_module/commands/validate.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
class ValidateCommand(Command):
1010
def __init__(self, parser):
1111
super().__init__(parser)
12+
parser.description = "Validate a YAML configuration file for structure definitions"
1213
parser.add_argument('yaml_file', type=str, help='Path to the YAML configuration file')
1314
parser.set_defaults(func=self.execute)
1415

0 commit comments

Comments
 (0)