Skip to content

Propagate @McpResource title to generated resources #6787

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.

Sign up for GitHub

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

Open
alpin87 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Propagate @McpResource title to generated resources #6787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions ...ava/org/springframework/ai/mcp/annotation/provider/resource/AsyncMcpResourceProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import io.modelcontextprotocol.spec.McpSchema.ReadResourceRequest;
import io.modelcontextprotocol.spec.McpSchema.ReadResourceResult;
import io.modelcontextprotocol.util.Assert;
import io.modelcontextprotocol.util.Utils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import reactor.core.publisher.Mono;
Expand Down Expand Up @@ -89,11 +90,13 @@ public List<AsyncResourceSpecification> getResourceSpecifications() {
}

var name = getName(mcpResourceMethod, resourceAnnotation);
var title = resourceAnnotation.title();
var description = resourceAnnotation.description();
var mimeType = resourceAnnotation.mimeType();
var meta = MetaUtils.getMeta(resourceAnnotation.metaProvider());

var mcpResource = McpSchema.Resource.builder(uri, name)
.title(Utils.hasText(title) ? title : null)
.description(description)
.mimeType(mimeType)
.meta(meta)
Expand Down Expand Up @@ -142,11 +145,13 @@ public List<AsyncResourceTemplateSpecification> getResourceTemplateSpecification
}

var name = getName(mcpResourceMethod, resourceAnnotation);
var title = resourceAnnotation.title();
var description = resourceAnnotation.description();
var mimeType = resourceAnnotation.mimeType();
var meta = MetaUtils.getMeta(resourceAnnotation.metaProvider());

var mcpResourceTemplate = McpSchema.ResourceTemplate.builder(uri, name)
.title(Utils.hasText(title) ? title : null)
.description(description)
.mimeType(mimeType)
.meta(meta)
Expand Down
5 changes: 5 additions & 0 deletions ...pringframework/ai/mcp/annotation/provider/resource/AsyncStatelessMcpResourceProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import io.modelcontextprotocol.spec.McpSchema.ReadResourceRequest;
import io.modelcontextprotocol.spec.McpSchema.ReadResourceResult;
import io.modelcontextprotocol.util.Assert;
import io.modelcontextprotocol.util.Utils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import reactor.core.publisher.Mono;
Expand Down Expand Up @@ -89,11 +90,13 @@ public List<AsyncResourceSpecification> getResourceSpecifications() {
}

var name = getName(mcpResourceMethod, resourceAnnotation);
var title = resourceAnnotation.title();
var description = resourceAnnotation.description();
var mimeType = resourceAnnotation.mimeType();
var meta = MetaUtils.getMeta(resourceAnnotation.metaProvider());

var mcpResource = McpSchema.Resource.builder(uri, name)
.title(Utils.hasText(title) ? title : null)
.description(description)
.mimeType(mimeType)
.meta(meta)
Expand Down Expand Up @@ -142,11 +145,13 @@ public List<AsyncResourceTemplateSpecification> getResourceTemplateSpecification
}

var name = getName(mcpResourceMethod, resourceAnnotation);
var title = resourceAnnotation.title();
var description = resourceAnnotation.description();
var mimeType = resourceAnnotation.mimeType();
var meta = MetaUtils.getMeta(resourceAnnotation.metaProvider());

var mcpResourceTemplate = McpSchema.ResourceTemplate.builder(uri, name)
.title(Utils.hasText(title) ? title : null)
.description(description)
.mimeType(mimeType)
.meta(meta)
Expand Down
5 changes: 5 additions & 0 deletions ...java/org/springframework/ai/mcp/annotation/provider/resource/SyncMcpResourceProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import io.modelcontextprotocol.server.McpServerFeatures.SyncResourceTemplateSpecification;
import io.modelcontextprotocol.spec.McpSchema;
import io.modelcontextprotocol.util.Assert;
import io.modelcontextprotocol.util.Utils;

import org.springframework.ai.mcp.annotation.McpResource;
import org.springframework.ai.mcp.annotation.common.McpPredicates;
Expand Down Expand Up @@ -63,11 +64,13 @@ public List<SyncResourceSpecification> getResourceSpecifications() {
}

var name = getName(mcpResourceMethod, resourceAnnotation);
var title = resourceAnnotation.title();
var description = resourceAnnotation.description();
var mimeType = resourceAnnotation.mimeType();
var meta = MetaUtils.getMeta(resourceAnnotation.metaProvider());

var mcpResource = McpSchema.Resource.builder(uri, name)
.title(Utils.hasText(title) ? title : null)
.description(description)
.mimeType(mimeType)
.meta(meta)
Expand Down Expand Up @@ -106,11 +109,13 @@ public List<SyncResourceTemplateSpecification> getResourceTemplateSpecifications
}

var name = getName(mcpResourceMethod, resourceAnnotation);
var title = resourceAnnotation.title();
var description = resourceAnnotation.description();
var mimeType = resourceAnnotation.mimeType();
var meta = MetaUtils.getMeta(resourceAnnotation.metaProvider());

var mcpResourceTemplate = McpSchema.ResourceTemplate.builder(uri, name)
.title(Utils.hasText(title) ? title : null)
.description(description)
.mimeType(mimeType)
.meta(meta)
Expand Down
5 changes: 5 additions & 0 deletions ...springframework/ai/mcp/annotation/provider/resource/SyncStatelessMcpResourceProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import io.modelcontextprotocol.spec.McpSchema.ReadResourceRequest;
import io.modelcontextprotocol.spec.McpSchema.ReadResourceResult;
import io.modelcontextprotocol.util.Assert;
import io.modelcontextprotocol.util.Utils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

Expand Down Expand Up @@ -88,11 +89,13 @@ public List<SyncResourceSpecification> getResourceSpecifications() {
}

var name = getName(mcpResourceMethod, resourceAnnotation);
var title = resourceAnnotation.title();
var description = resourceAnnotation.description();
var mimeType = resourceAnnotation.mimeType();
var meta = MetaUtils.getMeta(resourceAnnotation.metaProvider());

var mcpResource = McpSchema.Resource.builder(uri, name)
.title(Utils.hasText(title) ? title : null)
.description(description)
.mimeType(mimeType)
.meta(meta)
Expand Down Expand Up @@ -141,11 +144,13 @@ public List<SyncResourceTemplateSpecification> getResourceTemplateSpecifications
}

var name = getName(mcpResourceMethod, resourceAnnotation);
var title = resourceAnnotation.title();
var description = resourceAnnotation.description();
var mimeType = resourceAnnotation.mimeType();
var meta = MetaUtils.getMeta(resourceAnnotation.metaProvider());

var mcpResourceTemplate = McpSchema.ResourceTemplate.builder(uri, name)
.title(Utils.hasText(title) ? title : null)
.description(description)
.mimeType(mimeType)
.meta(meta)
Expand Down
57 changes: 57 additions & 0 deletions ...rg/springframework/ai/mcp/annotation/provider/resource/AsyncMcpResourceProviderTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,4 +495,61 @@ public Mono<String> syncMethodReturningMono() {
}).verifyComplete();
}

@Test
void testResourceTitleIsPropagated() {
class TitledResource {

@McpResource(uri = "test://titled", name = "titled-resource", title = "My Resource Title",
description = "A titled resource")
public Mono<String> titledResource() {
return Mono.just("content");
}

}

List<AsyncResourceSpecification> resourceSpecs = new AsyncMcpResourceProvider(List.of(new TitledResource()))
.getResourceSpecifications();

assertThat(resourceSpecs).hasSize(1);
assertThat(resourceSpecs.get(0).resource().title()).isEqualTo("My Resource Title");
}

@Test
void testResourceTemplateTitleIsPropagated() {
class TitledResourceTemplate {

@McpResource(uri = "test://titled/{id}", name = "titled-template", title = "My Template Title",
description = "A titled resource template")
public Mono<String> titledTemplate(String id) {
return Mono.just("content");
}

}

List<AsyncResourceTemplateSpecification> templateSpecs = new AsyncMcpResourceProvider(
List.of(new TitledResourceTemplate()))
.getResourceTemplateSpecifications();

assertThat(templateSpecs).hasSize(1);
assertThat(templateSpecs.get(0).resourceTemplate().title()).isEqualTo("My Template Title");
}

@Test
void testResourceTitleIsAbsentWhenNotSet() {
class UntitledResource {

@McpResource(uri = "test://untitled", name = "untitled-resource", description = "No title")
public Mono<String> untitledResource() {
return Mono.just("content");
}

}

List<AsyncResourceSpecification> resourceSpecs = new AsyncMcpResourceProvider(List.of(new UntitledResource()))
.getResourceSpecifications();

assertThat(resourceSpecs).hasSize(1);
assertThat(resourceSpecs.get(0).resource().title()).isNull();
}

}
59 changes: 59 additions & 0 deletions ...framework/ai/mcp/annotation/provider/resource/AsyncStatelessMcpResourceProviderTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,4 +496,63 @@ public Mono<String> syncMethodReturningMono() {
}).verifyComplete();
}

@Test
void testResourceTitleIsPropagated() {
class TitledResource {

@McpResource(uri = "test://titled", name = "titled-resource", title = "My Resource Title",
description = "A titled resource")
public Mono<String> titledResource() {
return Mono.just("content");
}

}

List<AsyncResourceSpecification> resourceSpecs = new AsyncStatelessMcpResourceProvider(
List.of(new TitledResource()))
.getResourceSpecifications();

assertThat(resourceSpecs).hasSize(1);
assertThat(resourceSpecs.get(0).resource().title()).isEqualTo("My Resource Title");
}

@Test
void testResourceTemplateTitleIsPropagated() {
class TitledResourceTemplate {

@McpResource(uri = "test://titled/{id}", name = "titled-template", title = "My Template Title",
description = "A titled resource template")
public Mono<String> titledTemplate(String id) {
return Mono.just("content");
}

}

List<AsyncResourceTemplateSpecification> templateSpecs = new AsyncStatelessMcpResourceProvider(
List.of(new TitledResourceTemplate()))
.getResourceTemplateSpecifications();

assertThat(templateSpecs).hasSize(1);
assertThat(templateSpecs.get(0).resourceTemplate().title()).isEqualTo("My Template Title");
}

@Test
void testResourceTitleIsAbsentWhenNotSet() {
class UntitledResource {

@McpResource(uri = "test://untitled", name = "untitled-resource", description = "No title")
public Mono<String> untitledResource() {
return Mono.just("content");
}

}

List<AsyncResourceSpecification> resourceSpecs = new AsyncStatelessMcpResourceProvider(
List.of(new UntitledResource()))
.getResourceSpecifications();

assertThat(resourceSpecs).hasSize(1);
assertThat(resourceSpecs.get(0).resource().title()).isNull();
}

}
57 changes: 57 additions & 0 deletions ...org/springframework/ai/mcp/annotation/provider/resource/SyncMcpResourceProviderTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -531,6 +531,63 @@ public String noParamResource() {
assertThat(((TextResourceContents) content).text()).isEqualTo("No parameters needed");
}

@Test
void testResourceTitleIsPropagated() {
class TitledResource {

@McpResource(uri = "test://titled", name = "titled-resource", title = "My Resource Title",
description = "A titled resource")
public String titledResource() {
return "content";
}

}

List<SyncResourceSpecification> resourceSpecs = new SyncMcpResourceProvider(List.of(new TitledResource()))
.getResourceSpecifications();

assertThat(resourceSpecs).hasSize(1);
assertThat(resourceSpecs.get(0).resource().title()).isEqualTo("My Resource Title");
}

@Test
void testResourceTemplateTitleIsPropagated() {
class TitledResourceTemplate {

@McpResource(uri = "test://titled/{id}", name = "titled-template", title = "My Template Title",
description = "A titled resource template")
public String titledTemplate(String id) {
return "content";
}

}

List<SyncResourceTemplateSpecification> templateSpecs = new SyncMcpResourceProvider(
List.of(new TitledResourceTemplate()))
.getResourceTemplateSpecifications();

assertThat(templateSpecs).hasSize(1);
assertThat(templateSpecs.get(0).resourceTemplate().title()).isEqualTo("My Template Title");
}

@Test
void testResourceTitleIsAbsentWhenNotSet() {
class UntitledResource {

@McpResource(uri = "test://untitled", name = "untitled-resource", description = "No title")
public String untitledResource() {
return "content";
}

}

List<SyncResourceSpecification> resourceSpecs = new SyncMcpResourceProvider(List.of(new UntitledResource()))
.getResourceSpecifications();

assertThat(resourceSpecs).hasSize(1);
assertThat(resourceSpecs.get(0).resource().title()).isNull();
}

public static class ResourceMetaProvider implements MetaProvider {

@Override
Expand Down
59 changes: 59 additions & 0 deletions ...gframework/ai/mcp/annotation/provider/resource/SyncStatelessMcpResourceProviderTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,4 +458,63 @@ public String requestResource(ReadResourceRequest request) {
assertThat(((TextResourceContents) content).text()).isEqualTo("Resource for URI: request://resource");
}

@Test
void testResourceTitleIsPropagated() {
class TitledResource {

@McpResource(uri = "test://titled", name = "titled-resource", title = "My Resource Title",
description = "A titled resource")
public String titledResource() {
return "content";
}

}

List<SyncResourceSpecification> resourceSpecs = new SyncStatelessMcpResourceProvider(
List.of(new TitledResource()))
.getResourceSpecifications();

assertThat(resourceSpecs).hasSize(1);
assertThat(resourceSpecs.get(0).resource().title()).isEqualTo("My Resource Title");
}

@Test
void testResourceTemplateTitleIsPropagated() {
class TitledResourceTemplate {

@McpResource(uri = "test://titled/{id}", name = "titled-template", title = "My Template Title",
description = "A titled resource template")
public String titledTemplate(String id) {
return "content";
}

}

List<SyncResourceTemplateSpecification> templateSpecs = new SyncStatelessMcpResourceProvider(
List.of(new TitledResourceTemplate()))
.getResourceTemplateSpecifications();

assertThat(templateSpecs).hasSize(1);
assertThat(templateSpecs.get(0).resourceTemplate().title()).isEqualTo("My Template Title");
}

@Test
void testResourceTitleIsAbsentWhenNotSet() {
class UntitledResource {

@McpResource(uri = "test://untitled", name = "untitled-resource", description = "No title")
public String untitledResource() {
return "content";
}

}

List<SyncResourceSpecification> resourceSpecs = new SyncStatelessMcpResourceProvider(
List.of(new UntitledResource()))
.getResourceSpecifications();

assertThat(resourceSpecs).hasSize(1);
assertThat(resourceSpecs.get(0).resource().title()).isNull();
}

}