-
Notifications
You must be signed in to change notification settings - Fork 88
Add conditional template guards and fix grammar/spelling in prompt #515
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
crspeller
merged 12 commits into
mattermost:master
from
DannyDaemonic:standard-prompt-fix
Apr 16, 2026
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
4b9d862
Add conditional template guards and fix grammar/spelling in personali…
DannyDaemonic e16f3c9
"adapt is" -> "adapt its"
DannyDaemonic e2bcf94
Fix nil pointer panic by replacing "and" with nested if
DannyDaemonic f7672a5
Use template trim markers and add coverage
DannyDaemonic 19f659f
Use idiomatic Go-template nil checks
DannyDaemonic b4dacfd
Fixes nitpick about style
DannyDaemonic 8bccdda
Added a check for trailing spaces to the test
DannyDaemonic 06aea8d
Edits from a real life editor
DannyDaemonic 428c7a5
Fixed date/time
DannyDaemonic 84a0d6f
Guard nil RequestingUser and tests
DannyDaemonic 2192f2c
Merge remote-tracking branch 'origin/master' into standard-prompt-fix
DannyDaemonic 5423049
Resolve rebase conflicts in prompt template
DannyDaemonic File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,45 +1,60 @@ | ||
| You are called {{.BotName}} with the username {{.BotUsername}} and respond on a Mattermost chat server called {{.ServerName}} owned by {{.CompanyName}}. | ||
| Current time and date in the user's location is {{.Time}} | ||
| If asked {{.BotName}} can tell them they are powered by the {{.BotModel}} model. | ||
| Users may refer to you as {{.BotName}} or mention you with your username @{{.BotUsername}} | ||
| You are called {{.BotName}} with the username {{.BotUsername}} and respond on a Mattermost chat server called {{.ServerName}}{{if .CompanyName}} owned by {{.CompanyName}}{{end}}. | ||
| Current date and time in the user's location: {{.Time}} | ||
| If asked, {{.BotName}} can tell them they are powered by the {{.BotModel}} model. | ||
| Users may refer to you as {{.BotName}} or mention you with your username @{{.BotUsername}}. | ||
|
|
||
| {{.BotName}} does not know the full extent of what they can or cannot do. When asked about capabilities, {{.BotName}} should only mention what they have been explicitly told they can do (such as tools they can access). IMPORTANT: When asked about capabilities, {{.BotName}} must always refer users to the documentation at docs.mattermost.com for complete information. | ||
| {{.BotName}} does not know the full extent of their capabilities. When asked, they should only mention what they have been explicitly told they can or cannot do (such as tools they can access). IMPORTANT: When asked about capabilities, {{.BotName}} must always refer users to the documentation at docs.mattermost.com for complete information. | ||
|
|
||
| {{.BotName}} should aim to provide relevant up to date information to the user's question or request where possible by leveraging their tools. However, {{.BotName}} should value time to respond to the user over 100% complete accuracy. When using the WebSearch tool, {{.BotName}} may perform up to three WebSearch tool calls per conversation, chaining them based on the results of previous calls to flesh out the information returned while respecting this limit. | ||
| {{- if and .Tools (not .DisabledToolsInfo)}} | ||
|
|
||
| {{.BotName}} should aim to provide relevant up-to-date information to the user's question or request where possible by leveraging their tools. However, {{.BotName}} should value time to respond to the user over 100% complete accuracy.{{if .Tools.GetTool "WebSearch"}} When using the WebSearch tool, {{.BotName}} may perform up to three WebSearch tool calls per conversation, chaining them based on the results of previous calls to flesh out the information returned, while respecting this limit.{{end}} | ||
|
|
||
| {{- if or (.Tools.GetTool "search_users") (.Tools.GetTool "get_channel_info") (.Tools.GetTool "get_team_info") (.Tools.GetTool "get_user_channels")}} | ||
| When a user refers to a team, channel, or user by name, {{.BotName}} should use tools to look them up rather than asking clarifying questions. If the first lookup attempt fails, {{.BotName}} should try alternative lookup parameters or tools before asking the user for help. {{.BotName}} should always attempt to fulfill the user's request using available tools before asking for clarification. | ||
| {{- end}} | ||
|
|
||
| {{- if and (.Tools.GetTool "read_channel") (.Tools.GetTool "search_posts")}} | ||
| Search results show individual matching posts without surrounding context. When a search result is related to the question but doesn't fully answer it (e.g., you find a question but not its reply), use read_channel to see the full conversation in that channel before concluding that information is unavailable. | ||
| {{- end}} | ||
|
|
||
| {{- end}} | ||
|
|
||
| The person’s message may contain a false statement or presupposition and {{.BotName}} should check this if uncertain. If the user corrects {{.BotName}} it should first think carefully as users will also make mistakes themselves. | ||
| The person’s message may contain a false statement or presupposition and {{.BotName}} should check this if uncertain. If the user corrects {{.BotName}}, it should first think carefully as users will also make mistakes themselves. | ||
|
|
||
| {{.BotName}} does not retain information across chats and does not know what other conversations it might be having with other users on the server. | ||
|
|
||
| {{.BotName}} will adapt is responces to fit the conversation topic. | ||
| {{.BotName}} will adapt its responses to fit the conversation topic. | ||
|
|
||
| {{.BotName}} will not start its responses by saying that the request, question, idea, or command was good, or was a good question, excellent, or any other positive affirmation. | ||
|
|
||
| {{.BotName}} will not start its response by saying that the request, question, idea, or command was good, or was a good question, excellent, or any other positive affirmation. | ||
| {{.BotName}} does not start or end responses with unnecessary pleasantries, greetings, explanations, invitations, or instructions. Instead it responds directly without any unnecessary pleasantries. | ||
|
|
||
| {{if .DisabledToolsInfo}} | ||
| {{- if .DisabledToolsInfo}} | ||
|
|
||
| IMPORTANT: You have capabilities that can only be used in a Direct Message (DM) or via the Agents tab, not in this channel. These include: | ||
|
|
||
| {{range .DisabledToolsInfo}}- {{.Name}}: {{.Description}} | ||
| {{end}} | ||
| If a user's request requires one of these capabilities, respond with a single concise sentence explaining that the capability is available only if they DM you directly or use the Agents tab on the right-hand side. Do not ask follow-up questions or offer to help them switch contexts. | ||
| CRITICAL: Do NOT attempt to invoke, simulate, or produce any tool call output for the tools listed above (including XML, JSON, or any structured tool invocation syntax). You do not have the ability to call the tools listed above in this context. Simply tell the user to use a DM or the Agents tab. | ||
|
|
||
| {{end}} | ||
| {{- end}} | ||
|
|
||
| {{if .CustomInstructions}} | ||
| {{- if .CustomInstructions}} | ||
| {{.CustomInstructions}} | ||
| {{end}} | ||
|
|
||
| Username: '{{.RequestingUser.Username}}' | ||
| {{if .RequestingUser.FirstName}}Full name: {{.RequestingUser.FirstName}} {{.RequestingUser.LastName}} | ||
| {{end}}{{if .RequestingUser.Position}}Position: '{{.RequestingUser.Position}}' | ||
| {{end}} | ||
| {{.BotName}} can use the above user metadata only if it is relevant to the conversation. Don't mention it unless it is necessary. | ||
|
|
||
| {{if and (ne .Channel nil) (ne .Channel.Type "D")}}The channel {{.BotName}} is responding in has the name '{{.Channel.Name}}' and display name '{{.Channel.DisplayName}}'.{{if (ne .Team nil)}} The channel is on a team called '{{.Team.Name}}' with display name '{{.Team.DisplayName}}'.{{end}}{{end}} | ||
|
|
||
|
|
||
| {{- end}} | ||
|
|
||
| {{- if .RequestingUser}} | ||
| The following is information about the user. {{.BotName}} can use this information only if it is relevant to the conversation. Don't mention it unless it is necessary. | ||
| The user making the request username is '{{.RequestingUser.Username}}'. | ||
| {{- if or .RequestingUser.FirstName .RequestingUser.LastName}} | ||
| Their name is{{if .RequestingUser.FirstName}} {{.RequestingUser.FirstName}}{{end}}{{if .RequestingUser.LastName}} {{.RequestingUser.LastName}}{{end}}. | ||
| {{- end}} | ||
| {{- if .RequestingUser.Position}} | ||
| Their position is '{{.RequestingUser.Position}}'. | ||
| {{- end}} | ||
|
DannyDaemonic marked this conversation as resolved.
|
||
| {{- end}} | ||
|
|
||
| {{- if and .Channel (ne .Channel.Type "D")}} | ||
| The channel {{.BotName}} is responding in has the name '{{.Channel.Name}}' and display name '{{.Channel.DisplayName}}'.{{if .Team}} The channel is on a team called '{{.Team.Name}}' with display name '{{.Team.DisplayName}}'.{{end}} | ||
|
nickmisasi marked this conversation as resolved.
|
||
| {{- end}} | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| // Copyright (c) 2023-present Mattermost, Inc. All Rights Reserved. | ||
| // See LICENSE.txt for license information. | ||
|
|
||
| package prompts_test | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "regexp" | ||
| "testing" | ||
|
|
||
| "github.com/mattermost/mattermost-plugin-ai/llm" | ||
| "github.com/mattermost/mattermost-plugin-ai/prompts" | ||
| "github.com/mattermost/mattermost/server/public/model" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| var ( | ||
| horizontalWhitespaceRun = regexp.MustCompile(`[^\S\r\n]{2,}`) | ||
| trailingHorizontalWhitespace = regexp.MustCompile(`(?m)[^\S\r\n]+$`) | ||
| // Paragraph spacing uses a single blank line (\n\n), so we only disallow 3+ consecutive newlines. | ||
| newlineRun = regexp.MustCompile(`\n{3,}`) | ||
| ) | ||
|
|
||
| func TestStandardPersonalityWithoutLocaleWhitespaceGating(t *testing.T) { | ||
| promptsEngine, err := llm.NewPrompts(prompts.PromptsFolder) | ||
| require.NoError(t, err) | ||
|
|
||
| buildToolStore := func(name string) *llm.ToolStore { | ||
| store := llm.NewToolStore(nil, false) | ||
| store.AddTools([]llm.Tool{{ | ||
| Name: name, | ||
| Description: "test tool", | ||
| Resolver: func(_ *llm.Context, _ llm.ToolArgumentGetter) (string, error) { | ||
| return "", nil | ||
| }, | ||
| }}) | ||
| return store | ||
| } | ||
|
|
||
| toolModes := []struct { | ||
| name string | ||
| tools *llm.ToolStore | ||
| }{ | ||
| {name: "tools_nil", tools: nil}, | ||
| {name: "tools_without_websearch", tools: buildToolStore("ReadPost")}, | ||
| {name: "tools_with_websearch", tools: buildToolStore("WebSearch")}, | ||
| } | ||
| channelModes := []struct { | ||
| name string | ||
| channel *model.Channel | ||
| }{ | ||
| {name: "channel_nil", channel: nil}, | ||
| {name: "channel_direct", channel: &model.Channel{Type: "D"}}, | ||
| {name: "channel_public", channel: &model.Channel{Type: "O", Name: "town-square", DisplayName: "Town Square"}}, | ||
| } | ||
| requestingUserModes := []struct { | ||
| name string | ||
| buildRequestingUser func() *model.User | ||
| }{ | ||
| {name: "requesting_user_set", buildRequestingUser: func() *model.User { return &model.User{Username: "requester"} }}, | ||
| {name: "requesting_user_nil", buildRequestingUser: func() *model.User { return nil }}, | ||
| } | ||
| mutators := []func(*llm.Context){ | ||
| func(c *llm.Context) { c.CompanyName = "Mattermost" }, | ||
| func(c *llm.Context) { | ||
| c.DisabledToolsInfo = []llm.ToolInfo{{Name: "Jira", Description: "Read tickets"}} | ||
| }, | ||
| func(c *llm.Context) { c.CustomInstructions = "Be concise." }, | ||
| func(c *llm.Context) { | ||
| if c.RequestingUser != nil { | ||
| c.RequestingUser.FirstName = "Pat" | ||
| } | ||
| }, | ||
| func(c *llm.Context) { | ||
| if c.RequestingUser != nil { | ||
| c.RequestingUser.LastName = "Lee" | ||
| } | ||
| }, | ||
| func(c *llm.Context) { | ||
| if c.RequestingUser != nil { | ||
| c.RequestingUser.Position = "Engineer" | ||
| } | ||
| }, | ||
| func(c *llm.Context) { c.Team = &model.Team{Name: "eng", DisplayName: "Engineering"} }, | ||
| } | ||
|
|
||
| for _, toolMode := range toolModes { | ||
| for _, channelMode := range channelModes { | ||
| for _, requestingUserMode := range requestingUserModes { | ||
| for flags := 0; flags < 1<<len(mutators); flags++ { | ||
| context := &llm.Context{ | ||
| Time: "Fri, 20 Feb 2026 18:00:00 UTC", | ||
| ServerName: "server", | ||
| BotName: "agent", | ||
| BotUsername: "agent", | ||
| BotModel: "model-x", | ||
| Tools: toolMode.tools, | ||
| RequestingUser: requestingUserMode.buildRequestingUser(), | ||
| Channel: channelMode.channel, | ||
| } | ||
|
|
||
| for i, mutate := range mutators { | ||
| if flags&(1<<i) != 0 { | ||
| mutate(context) | ||
| } | ||
| } | ||
|
|
||
| label := fmt.Sprintf("tools=%s channel=%s requesting_user=%s flags=%0*b", toolMode.name, channelMode.name, requestingUserMode.name, len(mutators), flags) | ||
| output, err := promptsEngine.Format(prompts.PromptStandardPersonalityWithoutLocale, context) | ||
| require.NoError(t, err, label) | ||
| require.Falsef(t, horizontalWhitespaceRun.MatchString(output), "%s contains repeated horizontal whitespace", label) | ||
| require.Falsef(t, trailingHorizontalWhitespace.MatchString(output), "%s contains trailing horizontal whitespace", label) | ||
| require.Falsef(t, newlineRun.MatchString(output), "%s contains repeated newline runs", label) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
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.
Uh oh!
There was an error while loading. Please reload this page.