Skip to content

The open-source agent harness - the runtime layer that turns an LLM into a working agent.

AGE-1602: Add GET route for retrieving configured MCP servers by name (#67)

Sujai Kumar Gupta22a4404855d4
diff --git a/fern/openapi/openapi.json b/fern/openapi/openapi.json
index c25ece2ce..48863c4d0 100644
--- a/fern/openapi/openapi.json
+++ b/fern/openapi/openapi.json
@@ -829,6 +829,17 @@
],
"type": "object"
},
+ "GetMcpServerResponse": {
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/ConfiguredMcpServer"
+ }
+ },
+ "required": [
+ "data"
+ ],
+ "type": "object"
+ },
"GetModelProviderCatalogResponse": {
"properties": {
"data": {
@@ -944,11 +955,11 @@
],
"type": "object"
},
- "ListConfiguredMcpServersResponse": {
+ "ListConfiguredSkillsResponse": {
"properties": {
"data": {
"items": {
- "$ref": "#/components/schemas/ConfiguredMcpServer"
+ "$ref": "#/components/schemas/SkillManifest"
},
"type": "array"
}
@@ -958,11 +969,13 @@
],
"type": "object"
},
- "ListConfiguredSkillsResponse": {
+ "ListMcpServerToolsResponse": {
"properties": {
"data": {
+ "description": "MCP `tools/list` entries, passed through verbatim from the MCP server.",
"items": {
- "$ref": "#/components/schemas/SkillManifest"
+ "additionalProperties": {},
+ "type": "object"
},
"type": "array"
}
@@ -972,13 +985,11 @@
],
"type": "object"
},
- "ListMcpServerToolsResponse": {
+ "ListMcpServersResponse": {
"properties": {
"data": {
- "description": "MCP `tools/list` entries, passed through verbatim from the MCP server.",
"items": {
- "additionalProperties": {},
- "type": "object"
+ "$ref": "#/components/schemas/ConfiguredMcpServer"
},
"type": "array"
}
@@ -3225,7 +3236,7 @@
},
"/api/v1/mcp-servers": {
"get": {
- "description": "Configured MCP servers as a slim name/url list for the composer. No auth or auth_status.",
+ "description": "MCP servers as a slim name/url list for the composer. No auth or auth_status.",
"responses": {
"200": {
"content": {
@@ -3235,7 +3246,7 @@
}
}
},
- "description": "All configured MCP servers (chat projection)."
+ "description": "All MCP servers (chat projection)."
}
},
"summary": "List MCP servers for chat",
@@ -3339,12 +3350,12 @@
"description": "For auth.type dcr, deletes the stored OAuth token and returns the server with auth_status auth_required, keeping the dynamically registered OAuth client so the next authorize can reuse it. No-op for header or no-auth servers (returns the server unchanged).",
"parameters": [
{
- "description": "Configured MCP server name.",
+ "description": "MCP server name.",
"in": "path",
"name": "name",
"required": true,
"schema": {
- "description": "Configured MCP server name.",
+ "description": "MCP server name.",
"minLength": 1,
"type": "string"
}
@@ -3372,7 +3383,7 @@
"description": "MCP server not found."
}
},
- "summary": "Disconnect OAuth for a configured MCP server",
+ "summary": "Disconnect OAuth for an MCP server",
"tags": [
"MCP Servers"
],
@@ -3385,12 +3396,12 @@
"description": "For servers without auth returns not_required, and for header credentials returns authenticated (no browser flow). For auth.type dcr, returns authenticated when a usable (or refreshable) token exists; otherwise runs DCR if needed and returns auth_required with an authorization URL. Optional redirect_url is where the OAuth callback then redirects the browser; without it the callback returns JSON.",
"parameters": [
{
- "description": "Configured MCP server name.",
+ "description": "MCP server name.",
"in": "path",
"name": "name",
"required": true,
"schema": {
- "description": "Configured MCP server name.",
+ "description": "MCP server name.",
"minLength": 1,
"type": "string"
}
@@ -3449,7 +3460,7 @@
"description": "Server misconfiguration (e.g. PUBLIC_BASE_URL unset)."
}
},
- "summary": "Start (or short-circuit) the auth flow for a configured MCP server",
+ "summary": "Start (or short-circuit) the auth flow for an MCP server",
"tags": [
"MCP Servers"
],
@@ -4398,20 +4409,20 @@
},
"/api/v1/settings/mcp-servers": {
"get": {
- "description": "All configured MCP servers with nested auth_status (settings / admin projection).",
+ "description": "All MCP servers with nested auth_status (settings / admin projection).",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ListConfiguredMcpServersResponse"
+ "$ref": "#/components/schemas/ListMcpServersResponse"
}
}
},
- "description": "All configured MCP servers."
+ "description": "All MCP servers."
}
},
- "summary": "List configured MCP servers",
+ "summary": "List MCP servers",
"tags": [
"MCP Servers"
],
@@ -4492,17 +4503,66 @@
"x-fern-sdk-method-name": "catalog"
}
},
+ "/api/v1/settings/mcp-servers/{name}": {
+ "get": {
+ "description": "A single MCP server by name, with nested auth_status (settings / admin projection).",
+ "parameters": [
+ {
+ "description": "MCP server name.",
+ "in": "path",
+ "name": "name",
+ "required": true,
+ "schema": {
+ "description": "MCP server name.",
+ "minLength": 1,
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetMcpServerResponse"
+ }
+ }
+ },
+ "description": "The MCP server."
+ },
+ "404": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RequestErrorResponse"
+ }
+ }
+ },
+ "description": "MCP server not found."
+ }
+ },
+ "summary": "Get a single MCP server by name",
+ "tags": [
+ "MCP Servers"
+ ],
+ "x-fern-sdk-group-name": [
+ "settings",
+ "mcpServers"
+ ],
+ "x-fern-sdk-method-name": "get"
+ }
+ },
"/api/v1/settings/mcp-servers/{name}/tools": {
"get": {
- "description": "All tools exposed by the given configured MCP server (non-paginated), as returned by the MCP `tools/list` call.",
+ "description": "All tools exposed by the given MCP server (non-paginated), as returned by the MCP `tools/list` call.",
"parameters": [
{
- "description": "Configured MCP server name.",
+ "description": "MCP server name.",
"in": "path",
"name": "name",
"required": true,
"schema": {
- "description": "Configured MCP server name.",
+ "description": "MCP server name.",
"minLength": 1,
"type": "string"
}
@@ -4550,7 +4610,7 @@
"description": "The MCP server could not be reached or returned an error."
}
},
- "summary": "List tools of a configured MCP server",
+ "summary": "List tools of an MCP server",
"tags": [
"MCP Servers"
],
diff --git a/packages/sdk/.fern/metadata.json b/packages/sdk/.fern/metadata.json
index ea92d0130..ebffe894d 100644
--- a/packages/sdk/.fern/metadata.json
+++ b/packages/sdk/.fern/metadata.json
@@ -27,9 +27,10 @@
"streamType": "web",
"useDefaultRequestParameterValues": true
},
- "originGitCommit": "2946f690bd580cf1dfdd51bad7f2ebb3cf208017",
+ "originGitCommit": "991608091f832a06ed81fd219599ce140ffbc830",
"originGitCommitIsDirty": true,
- "invokedBy": "manual",
+ "invokedBy": "ci",
"requestedVersion": "0.0.0",
+ "ciProvider": "github",
"sdkVersion": "0.0.0"
}
diff --git a/packages/sdk/reference.md b/packages/sdk/reference.md
index f67a0922e..48b2e544e 100644
--- a/packages/sdk/reference.md
+++ b/packages/sdk/reference.md
@@ -68,7 +68,7 @@ await client.server.getCapabilities();
<dl>
<dd>
-Configured MCP servers as a slim name/url list for the composer. No auth or auth_status.
+MCP servers as a slim name/url list for the composer. No auth or auth_status.
</dd>
</dl>
</dd>
@@ -154,7 +154,7 @@ await client.mcpServers.authorize("name");
<dl>
<dd>
-**name:** `string` — Configured MCP server name.
+**name:** `string` — MCP server name.
</dd>
</dl>
@@ -225,7 +225,7 @@ await client.mcpServers.deleteAuthorize("name");
<dl>
<dd>
-**name:** `string` — Configured MCP server name.
+**name:** `string` — MCP server name.
</dd>
</dl>
@@ -1208,7 +1208,7 @@ await client.skills.list();
</details>
## Settings McpServers
-<details><summary><code>client.settings.mcpServers.<a href="/src/api/resources/settings/resources/mcpServers/client/Client.ts">list</a>() -> TrueForge.ListConfiguredMcpServersResponse</code></summary>
+<details><summary><code>client.settings.mcpServers.<a href="/src/api/resources/settings/resources/mcpServers/client/Client.ts">list</a>() -> TrueForge.ListMcpServersResponse</code></summary>
<dl>
<dd>
@@ -1220,7 +1220,7 @@ await client.skills.list();
<dl>
<dd>
-All configured MCP servers with nested auth_status (settings / admin projection).
+All MCP servers with nested auth_status (settings / admin projection).
</dd>
</dl>
</dd>
@@ -1380,6 +1380,69 @@ await client.settings.mcpServers.catalog();
</dl>
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.settings.mcpServers.<a href="/src/api/resources/settings/resources/mcpServers/client/Client.ts">get</a>(name) -> TrueForge.GetMcpServerResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+A single MCP server by name, with nested auth_status (settings / admin projection).
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.settings.mcpServers.get("name");
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**name:** `string` — MCP server name.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `McpServersClient.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+
</dd>
</dl>
</details>
@@ -1396,7 +1459,7 @@ await client.settings.mcpServers.catalog();
<dl>
<dd>
-All tools exposed by the given configured MCP server (non-paginated), as returned by the MCP `tools/list` call.
+All tools exposed by the given MCP server (non-paginated), as returned by the MCP `tools/list` call.
</dd>
</dl>
</dd>
@@ -1427,7 +1490,7 @@ await client.settings.mcpServers.listTools("name");
<dl>
<dd>
-**name:** `string` — Configured MCP server name.
+**name:** `string` — MCP server name.
</dd>
</dl>
diff --git a/packages/sdk/src/api/resources/mcpServers/client/Client.ts b/packages/sdk/src/api/resources/mcpServers/client/Client.ts
index 5f17f421e..d4e39b809 100644
--- a/packages/sdk/src/api/resources/mcpServers/client/Client.ts
+++ b/packages/sdk/src/api/resources/mcpServers/client/Client.ts
@@ -23,7 +23,7 @@ export class McpServersClient {
}
/**
- * Configured MCP servers as a slim name/url list for the composer. No auth or auth_status.
+ * MCP servers as a slim name/url list for the composer. No auth or auth_status.
*
* @param {McpServersClient.RequestOptions} requestOptions - Request-specific configuration.
*
@@ -85,7 +85,7 @@ export class McpServersClient {
/**
* For servers without auth returns not_required, and for header credentials returns authenticated (no browser flow). For auth.type dcr, returns authenticated when a usable (or refreshable) token exists; otherwise runs DCR if needed and returns auth_required with an authorization URL. Optional redirect_url is where the OAuth callback then redirects the browser; without it the callback returns JSON.
*
- * @param {string} name - Configured MCP server name.
+ * @param {string} name - MCP server name.
* @param {TrueForge.AuthorizeMcpServersRequest} request
* @param {McpServersClient.RequestOptions} requestOptions - Request-specific configuration.
*
@@ -203,7 +203,7 @@ export class McpServersClient {
/**
* For auth.type dcr, deletes the stored OAuth token and returns the server with auth_status auth_required, keeping the dynamically registered OAuth client so the next authorize can reuse it. No-op for header or no-auth servers (returns the server unchanged).
*
- * @param {string} name - Configured MCP server name.
+ * @param {string} name - MCP server name.
* @param {McpServersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrueForge.NotFoundError}
diff --git a/packages/sdk/src/api/resources/settings/resources/mcpServers/client/Client.ts b/packages/sdk/src/api/resources/settings/resources/mcpServers/client/Client.ts
index 2b67e7456..6c95e4fce 100644
--- a/packages/sdk/src/api/resources/settings/resources/mcpServers/client/Client.ts
+++ b/packages/sdk/src/api/resources/settings/resources/mcpServers/client/Client.ts
@@ -24,7 +24,7 @@ export class McpServersClient {
}
/**
- * All configured MCP servers with nested auth_status (settings / admin projection).
+ * All MCP servers with nested auth_status (settings / admin projection).
*
* @param {McpServersClient.RequestOptions} requestOptions - Request-specific configuration.
*
@@ -36,13 +36,13 @@ export class McpServersClient {
*/
public list(
requestOptions?: McpServersClient.RequestOptions,
- ): core.HttpResponsePromise<TrueForge.ListConfiguredMcpServersResponse> {
+ ): core.HttpResponsePromise<TrueForge.ListMcpServersResponse> {
return core.HttpResponsePromise.fromPromise(this.__list(requestOptions));
}
private async __list(
requestOptions?: McpServersClient.RequestOptions,
- ): Promise<core.WithRawResponse<TrueForge.ListConfiguredMcpServersResponse>> {
+ ): Promise<core.WithRawResponse<TrueForge.ListMcpServersResponse>> {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(this._options?.headers, requestOptions?.headers);
const _response = await (this._options.fetcher ?? core.fetcher)({
url: core.url.join(
@@ -61,7 +61,7 @@ export class McpServersClient {
});
if (_response.ok) {
return {
- data: serializers.ListConfiguredMcpServersResponse.parseOrThrow(_response.body, {
+ data: serializers.ListMcpServersResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -244,9 +244,92 @@ export class McpServersClient {
}
/**
- * All tools exposed by the given configured MCP server (non-paginated), as returned by the MCP `tools/list` call.
+ * A single MCP server by name, with nested auth_status (settings / admin projection).
*
- * @param {string} name - Configured MCP server name.
+ * @param {string} name - MCP server name.
+ * @param {McpServersClient.RequestOptions} requestOptions - Request-specific configuration.
+ *
+ * @throws {@link TrueForge.NotFoundError}
+ * @throws {@link errors.TrueForgeError}
+ * @throws {@link errors.TrueForgeTimeoutError}
+ *
+ * @example
+ * await client.settings.mcpServers.get("name")
+ */
+ public get(
+ name: string,
+ requestOptions?: McpServersClient.RequestOptions,
+ ): core.HttpResponsePromise<TrueForge.GetMcpServerResponse> {
+ return core.HttpResponsePromise.fromPromise(this.__get(name, requestOptions));
+ }
+
+ private async __get(
+ name: string,
+ requestOptions?: McpServersClient.RequestOptions,
+ ): Promise<core.WithRawResponse<TrueForge.GetMcpServerResponse>> {
+ const _headers: core.Fetcher.Args["headers"] = mergeHeaders(this._options?.headers, requestOptions?.headers);
+ const _response = await (this._options.fetcher ?? core.fetcher)({
+ url: core.url.join(
+ (await core.Supplier.get(this._options.baseUrl)) ??
+ (await core.Supplier.get(this._options.environment)),
+ `api/v1/settings/mcp-servers/${core.url.encodePathParam(name)}`,
+ ),
+ method: "GET",
+ headers: _headers,
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
+ timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+ maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
+ fetchFn: this._options?.fetch,
+ logging: this._options.logging,
+ });
+ if (_response.ok) {
+ return {
+ data: serializers.GetMcpServerResponse.parseOrThrow(_response.body, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ skipValidation: true,
+ breadcrumbsPrefix: ["response"],
+ }),
+ rawResponse: _response.rawResponse,
+ };
+ }
+
+ if (_response.error.reason === "status-code") {
+ switch (_response.error.statusCode) {
+ case 404:
+ throw new TrueForge.NotFoundError(
+ serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ skipValidation: true,
+ breadcrumbsPrefix: ["response"],
+ }),
+ _response.rawResponse,
+ );
+ default:
+ throw new errors.TrueForgeError({
+ statusCode: _response.error.statusCode,
+ body: _response.error.body,
+ rawResponse: _response.rawResponse,
+ });
+ }
+ }
+
+ return handleNonStatusCodeError(
+ _response.error,
+ _response.rawResponse,
+ "GET",
+ "/api/v1/settings/mcp-servers/{name}",
+ );
+ }
+
+ /**
+ * All tools exposed by the given MCP server (non-paginated), as returned by the MCP `tools/list` call.
+ *
+ * @param {string} name - MCP server name.
* @param {McpServersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrueForge.UnauthorizedError}
diff --git a/packages/sdk/src/api/types/GetMcpServerResponse.ts b/packages/sdk/src/api/types/GetMcpServerResponse.ts
new file mode 100644
index 000000000..d03c780c8
--- /dev/null
+++ b/packages/sdk/src/api/types/GetMcpServerResponse.ts
@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../index.js";
+
+export interface GetMcpServerResponse {
+ data: TrueForge.ConfiguredMcpServer;
+}
diff --git a/packages/sdk/src/api/types/ListConfiguredMcpServersResponse.ts b/packages/sdk/src/api/types/ListMcpServersResponse.ts
similarity index 75%
rename from packages/sdk/src/api/types/ListConfiguredMcpServersResponse.ts
rename to packages/sdk/src/api/types/ListMcpServersResponse.ts
index 9849de8a3..e0165c61d 100644
--- a/packages/sdk/src/api/types/ListConfiguredMcpServersResponse.ts
+++ b/packages/sdk/src/api/types/ListMcpServersResponse.ts
@@ -2,6 +2,6 @@
import type * as TrueForge from "../index.js";
-export interface ListConfiguredMcpServersResponse {
+export interface ListMcpServersResponse {
data: TrueForge.ConfiguredMcpServer[];
}
diff --git a/packages/sdk/src/api/types/index.ts b/packages/sdk/src/api/types/index.ts
index 8c76673ce..d5c6e2d3a 100644
--- a/packages/sdk/src/api/types/index.ts
+++ b/packages/sdk/src/api/types/index.ts
@@ -40,6 +40,7 @@ export * from "./GetCapabilitiesResponseData.js";
export * from "./GetCapabilitiesResponseDataSandbox.js";
export * from "./GetCapabilitiesResponseDataSkill.js";
export * from "./GetMcpServerCatalogResponse.js";
+export * from "./GetMcpServerResponse.js";
export * from "./GetModelProviderCatalogResponse.js";
export * from "./GetSandboxProviderCatalogResponse.js";
export * from "./GetSandboxProviderResponse.js";
@@ -49,8 +50,8 @@ export * from "./GetTurnResponse.js";
export * from "./LargeToolResponseConfig.js";
export * from "./ListAvailableMcpServersResponse.js";
export * from "./ListAvailableSkillsResponse.js";
-export * from "./ListConfiguredMcpServersResponse.js";
export * from "./ListConfiguredSkillsResponse.js";
+export * from "./ListMcpServersResponse.js";
export * from "./ListMcpServerToolsResponse.js";
export * from "./ListModelProvidersResponse.js";
export * from "./ListModelsResponse.js";
diff --git a/packages/sdk/src/serialization/types/GetMcpServerResponse.ts b/packages/sdk/src/serialization/types/GetMcpServerResponse.ts
new file mode 100644
index 000000000..9021248bf
--- /dev/null
+++ b/packages/sdk/src/serialization/types/GetMcpServerResponse.ts
@@ -0,0 +1,19 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../../api/index.js";
+import * as core from "../../core/index.js";
+import type * as serializers from "../index.js";
+import { ConfiguredMcpServer } from "./ConfiguredMcpServer.js";
+
+export const GetMcpServerResponse: core.serialization.ObjectSchema<
+ serializers.GetMcpServerResponse.Raw,
+ TrueForge.GetMcpServerResponse
+> = core.serialization.object({
+ data: ConfiguredMcpServer,
+});
+
+export declare namespace GetMcpServerResponse {
+ export interface Raw {
+ data: ConfiguredMcpServer.Raw;
+ }
+}
diff --git a/packages/sdk/src/serialization/types/ListConfiguredMcpServersResponse.ts b/packages/sdk/src/serialization/types/ListMcpServersResponse.ts
similarity index 65%
rename from packages/sdk/src/serialization/types/ListConfiguredMcpServersResponse.ts
rename to packages/sdk/src/serialization/types/ListMcpServersResponse.ts
index f231692ab..cb4af53ea 100644
--- a/packages/sdk/src/serialization/types/ListConfiguredMcpServersResponse.ts
+++ b/packages/sdk/src/serialization/types/ListMcpServersResponse.ts
@@ -5,14 +5,14 @@ import * as core from "../../core/index.js";
import type * as serializers from "../index.js";
import { ConfiguredMcpServer } from "./ConfiguredMcpServer.js";
-export const ListConfiguredMcpServersResponse: core.serialization.ObjectSchema<
- serializers.ListConfiguredMcpServersResponse.Raw,
- TrueForge.ListConfiguredMcpServersResponse
+export const ListMcpServersResponse: core.serialization.ObjectSchema<
+ serializers.ListMcpServersResponse.Raw,
+ TrueForge.ListMcpServersResponse
> = core.serialization.object({
data: core.serialization.list(ConfiguredMcpServer),
});
-export declare namespace ListConfiguredMcpServersResponse {
+export declare namespace ListMcpServersResponse {
export interface Raw {
data: ConfiguredMcpServer.Raw[];
}
diff --git a/packages/sdk/src/serialization/types/index.ts b/packages/sdk/src/serialization/types/index.ts
index 8c76673ce..d5c6e2d3a 100644
--- a/packages/sdk/src/serialization/types/index.ts
+++ b/packages/sdk/src/serialization/types/index.ts
@@ -40,6 +40,7 @@ export * from "./GetCapabilitiesResponseData.js";
export * from "./GetCapabilitiesResponseDataSandbox.js";
export * from "./GetCapabilitiesResponseDataSkill.js";
export * from "./GetMcpServerCatalogResponse.js";
+export * from "./GetMcpServerResponse.js";
export * from "./GetModelProviderCatalogResponse.js";
export * from "./GetSandboxProviderCatalogResponse.js";
export * from "./GetSandboxProviderResponse.js";
@@ -49,8 +50,8 @@ export * from "./GetTurnResponse.js";
export * from "./LargeToolResponseConfig.js";
export * from "./ListAvailableMcpServersResponse.js";
export * from "./ListAvailableSkillsResponse.js";
-export * from "./ListConfiguredMcpServersResponse.js";
export * from "./ListConfiguredSkillsResponse.js";
+export * from "./ListMcpServersResponse.js";
export * from "./ListMcpServerToolsResponse.js";
export * from "./ListModelProvidersResponse.js";
export * from "./ListModelsResponse.js";
diff --git a/packages/sdk/tests/wire/settings/mcpServers.test.ts b/packages/sdk/tests/wire/settings/mcpServers.test.ts
index 030d03d34..d7ca55e34 100644
--- a/packages/sdk/tests/wire/settings/mcpServers.test.ts
+++ b/packages/sdk/tests/wire/settings/mcpServers.test.ts
@@ -145,6 +145,64 @@ describe("McpServersClient", () => {
});
});
+ test("get (1)", async () => {
+ const server = mockServerPool.createServer();
+ const client = new TrueForge({ maxRetries: 0, baseUrl: server.baseUrl });
+
+ const rawResponseBody = {
+ data: {
+ auth: { type: "dcr" },
+ auth_status: { authorization_url: "authorization_url", status: "authenticated" },
+ name: "name",
+ type: "remote",
+ url: "url",
+ },
+ };
+
+ server
+ .mockEndpoint()
+ .get("/api/v1/settings/mcp-servers/name")
+ .respondWith()
+ .statusCode(200)
+ .jsonBody(rawResponseBody)
+ .build();
+
+ const response = await client.settings.mcpServers.get("name");
+ expect(response).toEqual({
+ data: {
+ auth: {
+ type: "dcr",
+ },
+ authStatus: {
+ authorizationUrl: "authorization_url",
+ status: "authenticated",
+ },
+ name: "name",
+ type: "remote",
+ url: "url",
+ },
+ });
+ });
+
+ test("get (2)", async () => {
+ const server = mockServerPool.createServer();
+ const client = new TrueForge({ maxRetries: 0, baseUrl: server.baseUrl });
+
+ const rawResponseBody = { error: { message: "message" } };
+
+ server
+ .mockEndpoint()
+ .get("/api/v1/settings/mcp-servers/name")
+ .respondWith()
+ .statusCode(404)
+ .jsonBody(rawResponseBody)
+ .build();
+
+ await expect(async () => {
+ return await client.settings.mcpServers.get("name");
+ }).rejects.toThrow(TrueForgeTypes.NotFoundError);
+ });
+
test("list_tools (1)", async () => {
const server = mockServerPool.createServer();
const client = new TrueForge({ maxRetries: 0, baseUrl: server.baseUrl });
diff --git a/packages/server/src/apis/mcpServers.ts b/packages/server/src/apis/mcpServers.ts
index c66e3a272..4686dbc55 100644
--- a/packages/server/src/apis/mcpServers.ts
+++ b/packages/server/src/apis/mcpServers.ts
@@ -15,11 +15,12 @@ import { ensureMcpClientRegistered, isMcpAuthRequired, resolveMcpAuth } from '..
import { validateRedirectUris } from '../mcp/auth/mcpOAuthHelpers';
import type { IOAuthTokenStore, OAuthToken } from '../mcp/auth/types';
import {
- authorizeConfiguredMcpServerRoute,
- deleteConfiguredMcpServerAuthRoute,
+ authorizeMcpServerRoute,
+ deleteMcpServerAuthRoute,
getMcpServerCatalogRoute,
+ getMcpServerRoute,
listAvailableMcpServersRoute,
- listConfiguredMcpServersRoute,
+ listMcpServersRoute,
listMcpServerToolsRoute,
putMcpServerRoute,
} from '../routes/mcpServerRoutes';
@@ -104,7 +105,7 @@ export function createSettingsMcpServersRouter(deps: SettingsMcpServersRouterDep
return c.json({ data: [...deps.mcpCatalog.list()] }, 200);
};
- const listConfiguredHandler: RouteHandler<typeof listConfiguredMcpServersRoute> = async c => {
+ const listHandler: RouteHandler<typeof listMcpServersRoute> = async c => {
const records = await deps.mcpServerStore.listServers({ tenant_id: TENANT_ID, names: undefined });
const nowMs = Date.now();
// Only DCR servers have tokens; batch the lookup.
@@ -116,6 +117,19 @@ export function createSettingsMcpServersRouter(deps: SettingsMcpServersRouterDep
);
};
+ const getHandler: RouteHandler<typeof getMcpServerRoute> = async c => {
+ const { name } = c.req.valid('param');
+ const record = await deps.mcpServerStore.getServer({ tenant_id: TENANT_ID, name });
+ if (!record) {
+ return c.json({ error: { message: `MCP server not found: ${name}` } }, 404);
+ }
+ let token: OAuthToken | undefined;
+ if (record.manifest.auth?.type === 'dcr') {
+ token = await deps.tokenStore.getToken({ id: record.id });
+ }
+ return c.json({ data: toConfiguredMcpServer({ record, token }) }, 200);
+ };
+
const putHandler: RouteHandler<typeof putMcpServerRoute> = async c => {
const manifest: McpServerManifest = c.req.valid('json');
const record = await deps.mcpServerStore.upsertServer({
@@ -198,15 +212,17 @@ export function createSettingsMcpServersRouter(deps: SettingsMcpServersRouterDep
const router = new OpenAPIHono();
// Static `/catalog` before `/{name}/…` so "catalog" is not captured as a name.
router.openapi(getMcpServerCatalogRoute, catalogHandler);
- router.openapi(listConfiguredMcpServersRoute, listConfiguredHandler);
+ router.openapi(listMcpServersRoute, listHandler);
router.openapi(putMcpServerRoute, putHandler);
+ // `/{name}/tools` before `/{name}` so the tools suffix is not swallowed.
router.openapi(listMcpServerToolsRoute, listToolsHandler);
+ router.openapi(getMcpServerRoute, getHandler);
return router;
}
/** List + authorize (mounted at /api/v1/mcp-servers). */
export function createMcpServersRouter(deps: McpServersRouterDeps) {
- const authorizeHandler: RouteHandler<typeof authorizeConfiguredMcpServerRoute> = async c => {
+ const authorizeHandler: RouteHandler<typeof authorizeMcpServerRoute> = async c => {
const { name } = c.req.valid('param');
const { redirect_url: redirectUrl } = c.req.valid('query');
const record = await deps.mcpServerStore.getServer({ tenant_id: TENANT_ID, name });
@@ -249,7 +265,7 @@ export function createMcpServersRouter(deps: McpServersRouterDeps) {
}
};
- const deleteAuthHandler: RouteHandler<typeof deleteConfiguredMcpServerAuthRoute> = async c => {
+ const deleteAuthHandler: RouteHandler<typeof deleteMcpServerAuthRoute> = async c => {
const { name } = c.req.valid('param');
const record = await deps.mcpServerStore.getServer({ tenant_id: TENANT_ID, name });
if (!record) {
@@ -273,7 +289,7 @@ export function createMcpServersRouter(deps: McpServersRouterDeps) {
200,
);
});
- router.openapi(authorizeConfiguredMcpServerRoute, authorizeHandler);
- router.openapi(deleteConfiguredMcpServerAuthRoute, deleteAuthHandler);
+ router.openapi(authorizeMcpServerRoute, authorizeHandler);
+ router.openapi(deleteMcpServerAuthRoute, deleteAuthHandler);
return router;
}
diff --git a/packages/server/src/routes/mcpServerRoutes.ts b/packages/server/src/routes/mcpServerRoutes.ts
index 681a873b3..8a81bf57d 100644
--- a/packages/server/src/routes/mcpServerRoutes.ts
+++ b/packages/server/src/routes/mcpServerRoutes.ts
@@ -7,8 +7,9 @@ import { createRoute, z } from '@hono/zod-openapi';
import { RequestErrorResponseSchema } from '../schemas/errors';
import { GetMcpServerCatalogResponseSchema } from '../schemas/mcpCatalog';
import {
+ GetMcpServerResponseSchema,
ListAvailableMcpServersResponseSchema,
- ListConfiguredMcpServersResponseSchema,
+ ListMcpServersResponseSchema,
McpAuthStatusSchema,
PutMcpServerRequestSchema,
PutMcpServerResponseSchema,
@@ -40,29 +41,56 @@ export const listAvailableMcpServersRoute = createRoute({
path: '/',
tags: [MCP_SERVERS_TAG],
summary: 'List MCP servers for chat',
- description: 'Configured MCP servers as a slim name/url list for the composer. No auth or auth_status.',
+ description: 'MCP servers as a slim name/url list for the composer. No auth or auth_status.',
'x-fern-sdk-group-name': ['mcpServers'],
'x-fern-sdk-method-name': 'list',
responses: {
200: {
content: { 'application/json': { schema: ListAvailableMcpServersResponseSchema } },
- description: 'All configured MCP servers (chat projection).',
+ description: 'All MCP servers (chat projection).',
},
},
});
-export const listConfiguredMcpServersRoute = createRoute({
+export const listMcpServersRoute = createRoute({
method: 'get',
path: '/',
tags: [MCP_SERVERS_TAG],
- summary: 'List configured MCP servers',
- description: 'All configured MCP servers with nested auth_status (settings / admin projection).',
+ summary: 'List MCP servers',
+ description: 'All MCP servers with nested auth_status (settings / admin projection).',
'x-fern-sdk-group-name': ['settings', 'mcpServers'],
'x-fern-sdk-method-name': 'list',
responses: {
200: {
- content: { 'application/json': { schema: ListConfiguredMcpServersResponseSchema } },
- description: 'All configured MCP servers.',
+ content: { 'application/json': { schema: ListMcpServersResponseSchema } },
+ description: 'All MCP servers.',
+ },
+ },
+});
+
+const McpServerNameParamsSchema = z.object({
+ name: z.string().min(1).describe('MCP server name.'),
+});
+
+export const getMcpServerRoute = createRoute({
+ method: 'get',
+ path: '/{name}',
+ tags: [MCP_SERVERS_TAG],
+ summary: 'Get a single MCP server by name',
+ description: 'A single MCP server by name, with nested auth_status (settings / admin projection).',
+ 'x-fern-sdk-group-name': ['settings', 'mcpServers'],
+ 'x-fern-sdk-method-name': 'get',
+ request: {
+ params: McpServerNameParamsSchema,
+ },
+ responses: {
+ 200: {
+ content: { 'application/json': { schema: GetMcpServerResponseSchema } },
+ description: 'The MCP server.',
+ },
+ 404: {
+ content: { 'application/json': { schema: RequestErrorResponseSchema } },
+ description: 'MCP server not found.',
},
},
});
@@ -103,19 +131,14 @@ const ListMcpServerToolsResponseSchema = z
})
.openapi('ListMcpServerToolsResponse');
-const McpServerNameParamsSchema = z.object({
- name: z.string().min(1).describe('Configured MCP server name.'),
-});
-
export const listMcpServerToolsRoute = createRoute({
method: 'get',
path: '/{name}/tools',
tags: [MCP_SERVERS_TAG],
- summary: 'List tools of a configured MCP server',
+ summary: 'List tools of an MCP server',
'x-fern-sdk-group-name': ['settings', 'mcpServers'],
'x-fern-sdk-method-name': 'list_tools',
- description:
- 'All tools exposed by the given configured MCP server (non-paginated), as returned by the MCP `tools/list` call.',
+ description: 'All tools exposed by the given MCP server (non-paginated), as returned by the MCP `tools/list` call.',
request: {
params: McpServerNameParamsSchema,
},
@@ -146,11 +169,11 @@ const McpAuthorizeQuerySchema = z.object({
.describe('Optional FE landing URL the OAuth callback redirects to, with `isSuccess`/`reason` appended.'),
});
-export const authorizeConfiguredMcpServerRoute = createRoute({
+export const authorizeMcpServerRoute = createRoute({
method: 'get',
path: '/{name}/authorize',
tags: [MCP_SERVERS_TAG],
- summary: 'Start (or short-circuit) the auth flow for a configured MCP server',
+ summary: 'Start (or short-circuit) the auth flow for an MCP server',
'x-fern-sdk-group-name': ['mcpServers'],
'x-fern-sdk-method-name': 'authorize',
description:
@@ -182,11 +205,11 @@ export const authorizeConfiguredMcpServerRoute = createRoute({
},
});
-export const deleteConfiguredMcpServerAuthRoute = createRoute({
+export const deleteMcpServerAuthRoute = createRoute({
method: 'delete',
path: '/{name}/authorize',
tags: [MCP_SERVERS_TAG],
- summary: 'Disconnect OAuth for a configured MCP server',
+ summary: 'Disconnect OAuth for an MCP server',
'x-fern-sdk-group-name': ['mcpServers'],
'x-fern-sdk-method-name': 'delete_authorize',
description:
diff --git a/packages/server/src/schemas/mcpServer.ts b/packages/server/src/schemas/mcpServer.ts
index d4de0eb31..5c9683d9f 100644
--- a/packages/server/src/schemas/mcpServer.ts
+++ b/packages/server/src/schemas/mcpServer.ts
@@ -69,9 +69,10 @@ export const ConfiguredMcpServerSchema = McpServerManifestObjectSchema.extend({
export const PutMcpServerRequestSchema = McpServerManifestSchema;
export const PutMcpServerResponseSchema = z.object({ data: ConfiguredMcpServerSchema }).openapi('PutMcpServerResponse');
-export const ListConfiguredMcpServersResponseSchema = z
+export const GetMcpServerResponseSchema = z.object({ data: ConfiguredMcpServerSchema }).openapi('GetMcpServerResponse');
+export const ListMcpServersResponseSchema = z
.object({ data: z.array(ConfiguredMcpServerSchema) })
- .openapi('ListConfiguredMcpServersResponse');
+ .openapi('ListMcpServersResponse');
/** Chat/composer read view — no auth or auth_status. */
export const McpServerReadEntrySchema = z
diff --git a/packages/server/tests/unit/apis/mcpServers.test.ts b/packages/server/tests/unit/apis/mcpServers.test.ts
index f724d6d49..2895f0f35 100644
--- a/packages/server/tests/unit/apis/mcpServers.test.ts
+++ b/packages/server/tests/unit/apis/mcpServers.test.ts
@@ -98,6 +98,20 @@ describe('mcp-servers routers', () => {
});
});
+ it('GET /{name} returns the configured server and 404s unknowns', async () => {
+ const response = await settingsRouter.request(`/${putBody.name}`);
+ expect(response.status).toBe(200);
+ expect(await response.json()).toEqual({
+ data: { ...putBody, auth_status: { status: 'not_required' } },
+ });
+
+ const missing = await settingsRouter.request('/missing');
+ expect(missing.status).toBe(404);
+ expect(await missing.json()).toEqual({
+ error: { message: 'MCP server not found: missing' },
+ });
+ });
+
it('PUT with DCR auth reports auth_required while no token is stored', async () => {
const response = await settingsRouter.request('/', putInit(putBodyWithDcr));
expect(response.status).toBe(200);