|
| 1 | +package io.modelcontextprotocol.kotlin.sdk.server |
| 2 | + |
| 3 | +import io.kotest.matchers.collections.shouldBeEmpty |
| 4 | +import io.kotest.matchers.collections.shouldHaveSize |
| 5 | +import io.kotest.matchers.maps.shouldContainKey |
| 6 | +import io.kotest.matchers.nulls.shouldNotBeNull |
| 7 | +import io.kotest.matchers.shouldBe |
| 8 | +import io.modelcontextprotocol.kotlin.sdk.types.Implementation |
| 9 | +import io.modelcontextprotocol.kotlin.sdk.types.ListResourceTemplatesRequest |
| 10 | +import io.modelcontextprotocol.kotlin.sdk.types.McpException |
| 11 | +import io.modelcontextprotocol.kotlin.sdk.types.RPCError |
| 12 | +import io.modelcontextprotocol.kotlin.sdk.types.ReadResourceRequest |
| 13 | +import io.modelcontextprotocol.kotlin.sdk.types.ReadResourceRequestParams |
| 14 | +import io.modelcontextprotocol.kotlin.sdk.types.ReadResourceResult |
| 15 | +import io.modelcontextprotocol.kotlin.sdk.types.ResourceTemplate |
| 16 | +import io.modelcontextprotocol.kotlin.sdk.types.ServerCapabilities |
| 17 | +import io.modelcontextprotocol.kotlin.sdk.types.TextResourceContents |
| 18 | +import kotlinx.coroutines.CompletableDeferred |
| 19 | +import kotlinx.coroutines.test.runTest |
| 20 | +import org.junit.jupiter.api.Test |
| 21 | +import org.junit.jupiter.api.assertThrows |
| 22 | + |
| 23 | +class ServerResourceTemplateTest : AbstractServerFeaturesTest() { |
| 24 | + |
| 25 | + override fun getServerCapabilities(): ServerCapabilities = ServerCapabilities( |
| 26 | + resources = ServerCapabilities.Resources(listChanged = null, subscribe = null), |
| 27 | + ) |
| 28 | + |
| 29 | + @Test |
| 30 | + fun `listResourceTemplates should return registered templates`() = runTest { |
| 31 | + server.addResourceTemplate("test://data/{id}", "Test Data", mimeType = "text/plain") { _, _ -> |
| 32 | + ReadResourceResult(listOf(TextResourceContents("content", "test://data/1"))) |
| 33 | + } |
| 34 | + |
| 35 | + val result = client.listResourceTemplates(ListResourceTemplatesRequest()) |
| 36 | + |
| 37 | + result.resourceTemplates shouldHaveSize 1 |
| 38 | + result.resourceTemplates[0] shouldNotBeNull { |
| 39 | + uriTemplate shouldBe "test://data/{id}" |
| 40 | + name shouldBe "Test Data" |
| 41 | + mimeType shouldBe "text/plain" |
| 42 | + } |
| 43 | + } |
| 44 | + |
| 45 | + @Test |
| 46 | + fun `listResourceTemplates should return empty list when none registered`() = runTest { |
| 47 | + val result = client.listResourceTemplates(ListResourceTemplatesRequest()) |
| 48 | + |
| 49 | + result.resourceTemplates.shouldBeEmpty() |
| 50 | + } |
| 51 | + |
| 52 | + @Test |
| 53 | + fun `readResource should match URI against template and invoke handler`() = runTest { |
| 54 | + server.addResourceTemplate("test://items/{itemId}", "Item", mimeType = "text/plain") { request, variables -> |
| 55 | + val itemId = variables["itemId"] ?: "unknown" |
| 56 | + ReadResourceResult( |
| 57 | + listOf(TextResourceContents(text = "item=$itemId", uri = request.uri, mimeType = "text/plain")), |
| 58 | + ) |
| 59 | + } |
| 60 | + |
| 61 | + val result = client.readResource(ReadResourceRequest(ReadResourceRequestParams("test://items/42"))) |
| 62 | + |
| 63 | + result.contents shouldBe |
| 64 | + listOf(TextResourceContents(uri = "test://items/42", mimeType = "text/plain", text = "item=42")) |
| 65 | + } |
| 66 | + |
| 67 | + @Test |
| 68 | + fun `readResource should extract multiple URI template variables`() = runTest { |
| 69 | + val capturedVars = CompletableDeferred<Map<String, String>>() |
| 70 | + server.addResourceTemplate( |
| 71 | + uriTemplate = "test://users/{userId}/posts/{postId}", |
| 72 | + name = "User Post", |
| 73 | + mimeType = "text/plain", |
| 74 | + ) { _, variables -> |
| 75 | + capturedVars.complete(variables) |
| 76 | + ReadResourceResult(listOf(TextResourceContents("ok", "test://users/alice/posts/99"))) |
| 77 | + } |
| 78 | + |
| 79 | + client.readResource(ReadResourceRequest(ReadResourceRequestParams("test://users/alice/posts/99"))) |
| 80 | + |
| 81 | + val vars = capturedVars.await() |
| 82 | + vars shouldContainKey "userId" |
| 83 | + vars shouldContainKey "postId" |
| 84 | + vars["userId"] shouldBe "alice" |
| 85 | + vars["postId"] shouldBe "99" |
| 86 | + } |
| 87 | + |
| 88 | + @Test |
| 89 | + fun `readResource should prefer exact resource match over template`() = runTest { |
| 90 | + var exactHandlerCalled = false |
| 91 | + server.addResource("test://items/special", "Special Item", "An exact resource") { |
| 92 | + exactHandlerCalled = true |
| 93 | + ReadResourceResult(listOf(TextResourceContents("exact", "test://items/special"))) |
| 94 | + } |
| 95 | + server.addResourceTemplate("test://items/{itemId}", "Item Template") { _, _ -> |
| 96 | + ReadResourceResult(listOf(TextResourceContents("template", "test://items/special"))) |
| 97 | + } |
| 98 | + |
| 99 | + val result = client.readResource(ReadResourceRequest(ReadResourceRequestParams("test://items/special"))) |
| 100 | + |
| 101 | + exactHandlerCalled shouldBe true |
| 102 | + (result.contents[0] as TextResourceContents).text shouldBe "exact" |
| 103 | + } |
| 104 | + |
| 105 | + @Test |
| 106 | + fun `readResource should select most specific template when multiple match`() = runTest { |
| 107 | + // "test://users/profile" has more literal chars than "test://users/{id}" — should win |
| 108 | + server.addResourceTemplate("test://users/{id}", "Generic User") { _, variables -> |
| 109 | + ReadResourceResult(listOf(TextResourceContents("generic:${variables["id"]}", "test://users/profile"))) |
| 110 | + } |
| 111 | + server.addResourceTemplate("test://users/profile", "Profile") { _, _ -> |
| 112 | + ReadResourceResult(listOf(TextResourceContents("profile-page", "test://users/profile"))) |
| 113 | + } |
| 114 | + |
| 115 | + val result = client.readResource(ReadResourceRequest(ReadResourceRequestParams("test://users/profile"))) |
| 116 | + |
| 117 | + (result.contents[0] as TextResourceContents).text shouldBe "profile-page" |
| 118 | + } |
| 119 | + |
| 120 | + @Test |
| 121 | + fun `readResource should return RESOURCE_NOT_FOUND error when no match`() = runTest { |
| 122 | + val exception = assertThrows<McpException> { |
| 123 | + client.readResource(ReadResourceRequest(ReadResourceRequestParams("test://nonexistent/uri"))) |
| 124 | + } |
| 125 | + |
| 126 | + exception.code shouldBe RPCError.ErrorCode.RESOURCE_NOT_FOUND |
| 127 | + } |
| 128 | + |
| 129 | + @Test |
| 130 | + fun `resourceTemplates property should reflect registered templates`() { |
| 131 | + server.addResourceTemplate(ResourceTemplate("test://a/{x}", "A")) { _, _ -> |
| 132 | + ReadResourceResult(emptyList()) |
| 133 | + } |
| 134 | + server.addResourceTemplate(ResourceTemplate("test://b/{y}", "B")) { _, _ -> |
| 135 | + ReadResourceResult(emptyList()) |
| 136 | + } |
| 137 | + |
| 138 | + val templates = server.resourceTemplates |
| 139 | + |
| 140 | + templates shouldBe listOf( |
| 141 | + ResourceTemplate("test://a/{x}", "A"), |
| 142 | + ResourceTemplate("test://b/{y}", "B"), |
| 143 | + ) |
| 144 | + } |
| 145 | + |
| 146 | + @Test |
| 147 | + fun `removeResourceTemplate should remove a registered template`() { |
| 148 | + server.addResourceTemplate("test://items/{id}", "Item") { _, _ -> |
| 149 | + ReadResourceResult(emptyList()) |
| 150 | + } |
| 151 | + |
| 152 | + val removed = server.removeResourceTemplate("test://items/{id}") |
| 153 | + |
| 154 | + removed shouldBe true |
| 155 | + server.resourceTemplates.size shouldBe 0 |
| 156 | + } |
| 157 | + |
| 158 | + @Test |
| 159 | + fun `removeResourceTemplate should return false when template does not exist`() { |
| 160 | + val removed = server.removeResourceTemplate("test://nonexistent/{id}") |
| 161 | + |
| 162 | + removed shouldBe false |
| 163 | + } |
| 164 | + |
| 165 | + @Test |
| 166 | + fun `addResourceTemplate should throw when resources capability is not supported`() { |
| 167 | + val noResourcesServer = Server( |
| 168 | + serverInfo = Implementation("test", "1.0"), |
| 169 | + options = ServerOptions(capabilities = ServerCapabilities()), |
| 170 | + ) |
| 171 | + |
| 172 | + assertThrows<IllegalStateException> { |
| 173 | + noResourcesServer.addResourceTemplate("test://{id}", "Test") { _, _ -> |
| 174 | + ReadResourceResult(emptyList()) |
| 175 | + } |
| 176 | + } |
| 177 | + } |
| 178 | + |
| 179 | + @Test |
| 180 | + fun `addResourceTemplate with ResourceTemplate object should register correctly`() = runTest { |
| 181 | + val template = ResourceTemplate( |
| 182 | + uriTemplate = "test://docs/{section}", |
| 183 | + name = "Documentation", |
| 184 | + description = "API docs", |
| 185 | + mimeType = "text/html", |
| 186 | + ) |
| 187 | + server.addResourceTemplate(template) { request, variables -> |
| 188 | + val section = variables["section"] ?: "index" |
| 189 | + ReadResourceResult( |
| 190 | + listOf(TextResourceContents("docs for $section", request.uri, mimeType = "text/html")), |
| 191 | + ) |
| 192 | + } |
| 193 | + |
| 194 | + val result = client.readResource(ReadResourceRequest(ReadResourceRequestParams("test://docs/api"))) |
| 195 | + |
| 196 | + result.contents shouldHaveSize 1 |
| 197 | + (result.contents[0] as TextResourceContents).text shouldBe "docs for api" |
| 198 | + } |
| 199 | + |
| 200 | + @Test |
| 201 | + fun `listResourceTemplates should include description from template`() = runTest { |
| 202 | + server.addResourceTemplate( |
| 203 | + uriTemplate = "test://data/{id}", |
| 204 | + name = "Data", |
| 205 | + description = "Parameterized data resource", |
| 206 | + mimeType = "application/json", |
| 207 | + ) { _, _ -> |
| 208 | + ReadResourceResult(emptyList()) |
| 209 | + } |
| 210 | + |
| 211 | + val result = client.listResourceTemplates(ListResourceTemplatesRequest()) |
| 212 | + |
| 213 | + result.resourceTemplates shouldBe listOf( |
| 214 | + ResourceTemplate( |
| 215 | + name = "Data", |
| 216 | + uriTemplate = "test://data/{id}", |
| 217 | + description = "Parameterized data resource", |
| 218 | + mimeType = "application/json", |
| 219 | + ), |
| 220 | + ) |
| 221 | + } |
| 222 | +} |
0 commit comments