diff --git a/docs/how-to-guides/how-to-create-and-use-your-own-tool-package.md b/docs/how-to-guides/how-to-create-and-use-your-own-tool-package.md index a6c714dbf0c..5e36d3057f3 100644 --- a/docs/how-to-guides/how-to-create-and-use-your-own-tool-package.md +++ b/docs/how-to-guides/how-to-create-and-use-your-own-tool-package.md @@ -21,11 +21,11 @@ git clone https://github.com/microsoft/promptflow.git ### Create custom tool package Run below command under root folder to create your tool project quickly: ``` -python scripts\tool\generate_tool_package_template.py --destination --package-name --tool-name --function-name +python \tool\generate_tool_package_template.py --destination --package-name --tool-name --function-name ``` For example: ``` -python scripts\tool\generate_tool_package_template.py --destination hello-world-proj --package-name hello-world --tool-name hello_world_tool --function-name get_greeting_message +python D:\proj\github\promptflow\scripts\tool\generate_tool_package_template.py --destination hello-world-proj --package-name hello-world --tool-name hello_world_tool --function-name get_greeting_message ``` This auto-generated script will create one tool for you. The parameters _destination_ and _package-name_ are mandatory. The parameters _tool-name_ and _function-name_ are optional. If left unfilled, the _tool-name_ will default to _hello_world_tool_, and the _function-name_ will default to _tool-name_. @@ -64,7 +64,7 @@ hello-world-proj/ > [!Note] If you create a new tool, don't forget to also create the corresponding tool YAML. You can run below command under your tool project to auto generate your tool YAML. You may want to specify `-n` for `name` and `-d` for `description`, which would be displayed as the tool name and tooltip in prompt flow UI. ``` - python -m -o -n -d + python \tool\generate_package_tool_meta.py -m -o -n -d ``` For example: ```