Skip to content

Commit 1ff4a98

Browse files
committed
add meta value to prompt
allow title on prompt arguments
1 parent b5e344e commit 1ff4a98

File tree

4 files changed

+48
-10
lines changed

4 files changed

+48
-10
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -624,10 +624,12 @@ class MyPrompt < MCP::Prompt
624624
arguments [
625625
MCP::Prompt::Argument.new(
626626
name: "message",
627+
title: "Message Title",
627628
description: "Input message",
628629
required: true
629630
)
630631
]
632+
meta({ version: "1.0", category: "example" })
631633

632634
class << self
633635
def template(args, server_context:)
@@ -661,10 +663,12 @@ prompt = MCP::Prompt.define(
661663
arguments: [
662664
MCP::Prompt::Argument.new(
663665
name: "message",
666+
title: "Message Title",
664667
description: "Input message",
665668
required: true
666669
)
667-
]
670+
],
671+
meta: { version: "1.0", category: "example" }
668672
) do |args, server_context:|
669673
MCP::Prompt::Result.new(
670674
description: "Response description",
@@ -692,10 +696,12 @@ server.define_prompt(
692696
arguments: [
693697
Prompt::Argument.new(
694698
name: "message",
699+
title: "Message Title",
695700
description: "Input message",
696701
required: true
697702
)
698-
]
703+
],
704+
meta: { version: "1.0", category: "example" }
699705
) do |args, server_context:|
700706
Prompt::Result.new(
701707
description: "Response description",
@@ -718,7 +724,7 @@ e.g. around authentication state or user preferences.
718724

719725
### Key Components
720726

721-
- `MCP::Prompt::Argument` - Defines input parameters for the prompt template
727+
- `MCP::Prompt::Argument` - Defines input parameters for the prompt template with name, title, description, and required flag
722728
- `MCP::Prompt::Message` - Represents a message in the conversation with a role and content
723729
- `MCP::Prompt::Result` - The output of a prompt template containing description and messages
724730
- `MCP::Content::Text` - Text content for messages

lib/mcp/prompt.rb

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,20 @@ class << self
88
attr_reader :title_value
99
attr_reader :description_value
1010
attr_reader :arguments_value
11+
attr_reader :meta_value
1112

1213
def template(args, server_context: nil)
1314
raise NotImplementedError, "Subclasses must implement template"
1415
end
1516

1617
def to_h
17-
{ name: name_value, title: title_value, description: description_value, arguments: arguments_value.map(&:to_h) }.compact
18+
{
19+
name: name_value,
20+
title: title_value,
21+
description: description_value,
22+
arguments: arguments_value&.map(&:to_h),
23+
_meta: meta_value,
24+
}.compact
1825
end
1926

2027
def inherited(subclass)
@@ -23,6 +30,7 @@ def inherited(subclass)
2330
subclass.instance_variable_set(:@title_value, nil)
2431
subclass.instance_variable_set(:@description_value, nil)
2532
subclass.instance_variable_set(:@arguments_value, nil)
33+
subclass.instance_variable_set(:@meta_value, nil)
2634
end
2735

2836
def prompt_name(value = NOT_SET)
@@ -61,7 +69,15 @@ def arguments(value = NOT_SET)
6169
end
6270
end
6371

64-
def define(name: nil, title: nil, description: nil, arguments: [], &block)
72+
def meta(value = NOT_SET)
73+
if value == NOT_SET
74+
@meta_value
75+
else
76+
@meta_value = value
77+
end
78+
end
79+
80+
def define(name: nil, title: nil, description: nil, arguments: [], meta: nil, &block)
6581
Class.new(self) do
6682
prompt_name name
6783
title title
@@ -70,6 +86,7 @@ def define(name: nil, title: nil, description: nil, arguments: [], &block)
7086
define_singleton_method(:template) do |args, server_context: nil|
7187
instance_exec(args, server_context:, &block)
7288
end
89+
meta meta
7390
end
7491
end
7592

lib/mcp/prompt/argument.rb

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,22 @@
33
module MCP
44
class Prompt
55
class Argument
6-
attr_reader :name, :description, :required, :arguments
6+
attr_reader :name, :title, :description, :required
77

8-
def initialize(name:, description: nil, required: false)
8+
def initialize(name:, title: nil, description: nil, required: false)
99
@name = name
10+
@title = title
1011
@description = description
1112
@required = required
12-
@arguments = arguments
1313
end
1414

1515
def to_h
16-
{ name:, description:, required: }.compact
16+
{
17+
name: name,
18+
title: title,
19+
description: description,
20+
required: required,
21+
}.compact
1722
end
1823
end
1924
end

test/mcp/prompt_test.rb

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,14 @@ def template(args, server_context:)
113113
title: "Mock Prompt",
114114
description: "a mock prompt for testing",
115115
arguments: [
116-
Prompt::Argument.new(name: "test_argument", description: "Test argument", required: true),
116+
Prompt::Argument.new(
117+
name: "test_argument",
118+
title: "Test argument title",
119+
description: "This is a test argument description",
120+
required: true,
121+
),
117122
],
123+
meta: { foo: "bar" },
118124
) do |args, server_context:|
119125
content = Content::Text.new(args["test_argument"] + " user: #{server_context[:user_id]}")
120126

@@ -130,6 +136,10 @@ def template(args, server_context:)
130136
assert_equal "mock_prompt", prompt.name_value
131137
assert_equal "a mock prompt for testing", prompt.description
132138
assert_equal "test_argument", prompt.arguments.first.name
139+
assert_equal "Test argument title", prompt.arguments.first.title
140+
assert_equal "This is a test argument description", prompt.arguments.first.description
141+
assert prompt.arguments.first.required
142+
assert_equal({ foo: "bar" }, prompt.meta_value)
133143

134144
expected = {
135145
description: "Hello, world!",

0 commit comments

Comments
 (0)