Class MentionParser

Parses @-mentions out of conversation message text.

Pure logic — no framework deps, no I/O, no observable state. Safe to call from browser, Node, tests, or anywhere TypeScript runs.

Consumers usually access this via ConversationsRuntime.Instance.Mentions.

Index

Constructors

Methods

extractMentionNames formatMentions parseMentions toPlainText validateMentions

Constructors

constructor

new MentionParser(): MentionParser
Returns MentionParser

Methods

extractMentionNames

extractMentionNames(text: string): string[]
Extract every raw mention name from text (no resolution against agents/users).
Parameters
- text: string
Returns string[]
- Defined in ConversationsRuntime/src/mentions/MentionParser.ts:228

formatMentions

formatMentions(text: string, mentions: Mention[]): string
Rewrite mentions in text to a canonical @Name format using the proper casing from mentions. Useful when normalizing user-typed mentions before storage or display.
Parameters
- text: string
- mentions: Mention[]
Returns string
- Defined in ConversationsRuntime/src/mentions/MentionParser.ts:254

parseMentions

parseMentions(
    text: string,
    availableAgents: MJAIAgentEntityExtended[],
    availableUsers?: UserInfo[],
): MentionParseResult
Parse every mention out of the supplied text.

Tries JSON format first; if no JSON mentions are present, falls back to the legacy text format and resolves names against availableAgents / availableUsers.
Parameters
- text: string
  Message text to parse
- availableAgents: MJAIAgentEntityExtended[]
  Agents to resolve legacy @Name references against
- OptionalavailableUsers: UserInfo[]
  Optional users to resolve legacy @Name references against
Returns MentionParseResult
Parsed mentions with agent/user separation
Example
```
const result = parser.parseMentions(
    '@Sage help me with this',
    AIEngineBase.Instance.Agents
);
if (result.agentMention) {
    // Route the message to result.agentMention.id
}
```
- Defined in ConversationsRuntime/src/mentions/MentionParser.ts:82

toPlainText

toPlainText(
    text: string,
    agents?: MJAIAgentEntityExtended[],
    users?: UserInfo[],
): string
Convert a message containing JSON-encoded mentions to plain text — @{…} blocks become simple @Name strings. Delegates to ConversationUtility.ToPlainText which is the canonical implementation.
Parameters
- text: string
- Optionalagents: MJAIAgentEntityExtended[]
- Optionalusers: UserInfo[]
Returns string
Example
```
// Input:  '@{"type":"agent","id":"123","name":"Sage"} help me'
// Output: '@Sage help me'
```
- Defined in ConversationsRuntime/src/mentions/MentionParser.ts:283

validateMentions

validateMentions(
    text: string,
    availableAgents: MJAIAgentEntityExtended[],
    availableUsers?: UserInfo[],
): string[]
Validate every mention in text. Returns an array of mention names that could not be resolved to a known agent or user.
Parameters
- text: string
- availableAgents: MJAIAgentEntityExtended[]
- OptionalavailableUsers: UserInfo[]
Returns string[]
- Defined in ConversationsRuntime/src/mentions/MentionParser.ts:169