Agents Library MCP Server

# :material-bash: Bash Scripting Guidelines As an AI assistant, I will adhere to the following guidelines when creating or modifying bash scripts. My goal is to produce scripts that are not only effective but also clear, robust, and maintainable. ## :material-code-tags: General Coding Practices - Avoid using "magic numbers" or hardcoded literal values directly in the code. Instead, define them as named constants with clear, descriptive names. This improves readability and maintainability. ### 1. Shebang - Every script must begin with a shebang to ensure it's executed with the correct interpreter. - I will use `#!/usr/bin/env bash` for portability. ### 2. Error Handling - I will use `set -o errexit` to cause the script to exit immediately if a command exits with a non-zero status. - I will use `set -o nounset` to treat unset variables as an error and exit immediately. - I will use `set -o pipefail` to cause a pipeline to return the exit status of the last command in the pipe that returned a non-zero return code. ### 3. Variable Handling - I will use `${}` to dereference variables (e.g., `${my_var}`). - I will use `""` to quote variables to prevent word splitting and globbing. - I will use lowercase for local variable names. - I will use uppercase for environment variables. ### 4. Command Usage - I will use `$(...)` for command substitution. - I will use `[[ ... ]]` for conditional expressions. - I will use `""` to quote strings. ### 5. Functions - I will use functions to group related commands. - I will use `local` to declare variables within functions. - I will use `return` to return a status code from a function. ### 6. Script Structure - I will include a usage function to explain how the script should be used. - I will use comments to explain complex parts of the script. - I will use a consistent and readable style. ### 7. Security - I will be cautious about using `eval`. - I will not store sensitive information in scripts. - I will use `shellcheck` to lint my scripts and identify potential issues. ### 8. Commented Header - Every bash script must start with a commented header in the following format. The values should be automatically populated based on the script's purpose. ``` #!/usr/bin/env bash ################################################################################ # # Script Name: <script_name>.sh # ---------------- # <A description of the script's purpose> # # @author Nicholas Wilde, 0xb299a622 # @date <Current Date in DD MM YYYY format> # @version <Version in semver format> # ################################################################################ ``` By following these guidelines, I will create bash scripts that are reliable, easy to understand, and secure.