Adding doc entry for AI Traits #2750
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yasmewad
force-pushed
the
ai-traits-doc
branch
from
f1ea7c8 to
498e998
Compare
mtdowling
requested changes
Aug 21, 2025
| A complete example | ||
| ===================== | ||
|
|
||
| The following example demonstrates creative prompt templates that enhance user experience with a weather service: |
There was a problem hiding this comment.
Suggested change
| The following example demonstrates creative prompt templates that enhance user experience with a weather service: | |
| The following example demonstrates creative prompt templates that enhance the user experience with a weather service: |
|
|
||
|
|
||
| A complete example | ||
| ===================== |
| arguments: VacationPlannerInput | ||
| } | ||
| }) | ||
|
|
|
|
||
|
|
||
| Use cases for prompts | ||
| ======================= |
|
|
||
|
|
||
| Template Placeholder Syntax | ||
| ============================ |
| Template Placeholder Syntax | ||
| ============================ | ||
|
|
||
| Prompt templates use ``{{parameterName}}`` syntax to reference parameters from the associated ``arguments`` structure. This can be useful to reference and interpolate members of arguments when accepting user input for prompts in Model Context Protocol (MCP) servers. |
There was a problem hiding this comment.
any way to escape templates (e.g., what if a template is supposed to generate a mustache template that uses literal {{}})?
There was a problem hiding this comment.
Good point. I did a little test. Ideally, this becomes the responsibility of the processor which in our case is Smithy java MCP Server.
I tested with this example and it works well:
template_escape_example: {
description: "Example showing how to escape template literals"
template: "Generate mustache template for {{loginId}}: \\{{\\{{name\\}\\}}} works at \\{{\\{{company\\}\\}}}"
arguments: GetEmployeeDetailsInput
preferWhen: "User needs to generate templates with literal mustache syntax"
}
It handled it correctly in Q CLI:
> @template_escape_example yasmewad
> Here's a mustache template for yasmewad:
🛠️ Using tool: fs_write
⋮
● Path: /Volumes/workplace/smithy-java-2/yasmewad-template.mustache
+ 1: {{name}} works at {{company}}.
⋮
↳ Purpose: Create mustache template with name and company variables
It correctly applied the arguments yasmewad to the {{login}} and created a file with escaped text.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background
adding AI Traits documentation page.
This will live under
Additional Specson our website.Links
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.