Class: PromptArgument

Defined in: packages/core/src/domain/PromptArgument.ts:17

Represents a named argument for an MCP Prompt.

Example

import { PromptArgument } from '@vinkius-core/mcp-fusion';

const arg = new PromptArgument('text');
arg.required = true;
arg.description = 'The text to summarize';

See

Prompt for the parent prompt

Extends

• BaseModel

Constructors

Constructor

new PromptArgument(name): PromptArgument;

Defined in: packages/core/src/domain/PromptArgument.ts:21

Parameters

Parameter	Type
name	string

Returns

PromptArgument

Overrides

BaseModel.constructor

Properties

description

description: string | undefined;

Defined in: packages/core/src/domain/BaseModel.ts:33

Detailed description of this entity's purpose

Inherited from

BaseModel.description

---

icons

icons: Icon[] | undefined;

Defined in: packages/core/src/domain/BaseModel.ts:37

Visual icons associated with this entity

Inherited from

BaseModel.icons

---

meta

meta: Map<string, unknown> | undefined;

Defined in: packages/core/src/domain/BaseModel.ts:35

Arbitrary key-value metadata for extensibility

Inherited from

BaseModel.meta

---

name

readonly name: string;

Defined in: packages/core/src/domain/BaseModel.ts:29

Unique identifier within the parent scope

Inherited from

BaseModel.name

---

nameSeparator

readonly nameSeparator: string;

Defined in: packages/core/src/domain/BaseModel.ts:27

Separator character for constructing fully qualified names

Inherited from

BaseModel.nameSeparator

---

required

required: boolean = false;

Defined in: packages/core/src/domain/PromptArgument.ts:19

Whether this argument must be provided when invoking the prompt

---

title

title: string | undefined;

Defined in: packages/core/src/domain/BaseModel.ts:31

Human-readable display title

Inherited from

BaseModel.title

---

DEFAULT_SEPARATOR

readonly static DEFAULT_SEPARATOR: string = ".";

Defined in: packages/core/src/domain/BaseModel.ts:24

Default separator used in fully qualified names

Inherited from

BaseModel.DEFAULT_SEPARATOR

Methods

getFullyQualifiedName()

getFullyQualifiedName(): string;

Defined in: packages/core/src/domain/PromptArgument.ts:26

Returns the simple argument name

Returns

string

Overrides

BaseModel.getFullyQualifiedName