@ubuligan/client 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/dist/index.d.ts +43 -0
- package/dist/index.js +103 -0
- package/dist/index.js.map +1 -0
- package/package.json +52 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 jsznpm
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { Client } from '@modelcontextprotocol/sdk/client/index.js';
|
|
2
|
+
import { ListToolsResult, CallToolResult, ListResourcesResult, ReadResourceResult, ListPromptsResult, GetPromptResult } from '@modelcontextprotocol/sdk/types.js';
|
|
3
|
+
import { TransportConfig, AuthConfig, RetryOptions, Logger, LogLevel } from '@ubuligan/shared';
|
|
4
|
+
export { AuthConfig, HttpTransportConfig, LogLevel, Logger, RetryOptions, StdioTransportConfig, TransportConfig } from '@ubuligan/shared';
|
|
5
|
+
|
|
6
|
+
interface MCPClientOptions {
|
|
7
|
+
/** How to reach the server (stdio or Streamable HTTP). */
|
|
8
|
+
transport: TransportConfig;
|
|
9
|
+
/** Optional auth applied to HTTP transports. */
|
|
10
|
+
auth?: AuthConfig;
|
|
11
|
+
/** Retry policy applied to every request. Set `retries: 1` to disable. */
|
|
12
|
+
retry?: RetryOptions;
|
|
13
|
+
/** Provide a custom logger, or a level for the built-in console logger. */
|
|
14
|
+
logger?: Logger | LogLevel;
|
|
15
|
+
/** Client identity advertised to the server. */
|
|
16
|
+
name?: string;
|
|
17
|
+
version?: string;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* A thin, ergonomic wrapper over the MCP SDK `Client`. Every request is wrapped
|
|
21
|
+
* with retry + logging; transport and auth are config-driven. The underlying
|
|
22
|
+
* SDK client is exposed as `.raw` for advanced use.
|
|
23
|
+
*/
|
|
24
|
+
declare class MCPClient {
|
|
25
|
+
readonly raw: Client;
|
|
26
|
+
private connected;
|
|
27
|
+
private readonly opts;
|
|
28
|
+
private readonly logger;
|
|
29
|
+
constructor(opts: MCPClientOptions);
|
|
30
|
+
connect(): Promise<this>;
|
|
31
|
+
close(): Promise<void>;
|
|
32
|
+
private run;
|
|
33
|
+
listTools(): Promise<ListToolsResult>;
|
|
34
|
+
callTool(name: string, args?: Record<string, unknown>): Promise<CallToolResult>;
|
|
35
|
+
listResources(): Promise<ListResourcesResult>;
|
|
36
|
+
readResource(uri: string): Promise<ReadResourceResult>;
|
|
37
|
+
listPrompts(): Promise<ListPromptsResult>;
|
|
38
|
+
getPrompt(name: string, args?: Record<string, string>): Promise<GetPromptResult>;
|
|
39
|
+
}
|
|
40
|
+
/** Create and connect an {@link MCPClient} in one call. */
|
|
41
|
+
declare function createMCPClient(opts: MCPClientOptions): Promise<MCPClient>;
|
|
42
|
+
|
|
43
|
+
export { MCPClient, type MCPClientOptions, createMCPClient, MCPClient as default };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
// src/index.ts
|
|
2
|
+
import { Client } from "@modelcontextprotocol/sdk/client/index.js";
|
|
3
|
+
import {
|
|
4
|
+
createConsoleLogger,
|
|
5
|
+
noopLogger,
|
|
6
|
+
withRetry
|
|
7
|
+
} from "@ubuligan/shared";
|
|
8
|
+
|
|
9
|
+
// src/transport.ts
|
|
10
|
+
import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";
|
|
11
|
+
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
|
|
12
|
+
import { resolveAuthHeaders } from "@ubuligan/shared";
|
|
13
|
+
async function buildTransport(config, auth) {
|
|
14
|
+
if (config.type === "stdio") {
|
|
15
|
+
return new StdioClientTransport({
|
|
16
|
+
command: config.command,
|
|
17
|
+
args: config.args,
|
|
18
|
+
cwd: config.cwd,
|
|
19
|
+
env: { ...process.env, ...config.env ?? {} }
|
|
20
|
+
});
|
|
21
|
+
}
|
|
22
|
+
const headers = { ...await resolveAuthHeaders(auth), ...config.headers ?? {} };
|
|
23
|
+
return new StreamableHTTPClientTransport(new URL(config.url), {
|
|
24
|
+
requestInit: { headers }
|
|
25
|
+
});
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
// src/index.ts
|
|
29
|
+
function resolveLogger(logger) {
|
|
30
|
+
if (!logger) return noopLogger;
|
|
31
|
+
if (typeof logger === "string") return createConsoleLogger(logger);
|
|
32
|
+
return logger;
|
|
33
|
+
}
|
|
34
|
+
var MCPClient = class {
|
|
35
|
+
raw;
|
|
36
|
+
connected = false;
|
|
37
|
+
opts;
|
|
38
|
+
logger;
|
|
39
|
+
constructor(opts) {
|
|
40
|
+
this.opts = opts;
|
|
41
|
+
this.logger = resolveLogger(opts.logger);
|
|
42
|
+
this.raw = new Client({
|
|
43
|
+
name: opts.name ?? "mcp-toolkit-client",
|
|
44
|
+
version: opts.version ?? "0.1.0"
|
|
45
|
+
});
|
|
46
|
+
}
|
|
47
|
+
async connect() {
|
|
48
|
+
if (this.connected) return this;
|
|
49
|
+
const transport = await buildTransport(this.opts.transport, this.opts.auth);
|
|
50
|
+
this.logger.info("connecting", { transport: this.opts.transport.type });
|
|
51
|
+
await this.raw.connect(transport);
|
|
52
|
+
this.connected = true;
|
|
53
|
+
this.logger.info("connected");
|
|
54
|
+
return this;
|
|
55
|
+
}
|
|
56
|
+
async close() {
|
|
57
|
+
if (!this.connected) return;
|
|
58
|
+
await this.raw.close();
|
|
59
|
+
this.connected = false;
|
|
60
|
+
this.logger.info("closed");
|
|
61
|
+
}
|
|
62
|
+
run(label, fn) {
|
|
63
|
+
if (!this.connected) {
|
|
64
|
+
throw new Error("MCPClient is not connected \xE2\u20AC\u201D call connect() first");
|
|
65
|
+
}
|
|
66
|
+
return withRetry(fn, this.opts.retry, this.logger, label);
|
|
67
|
+
}
|
|
68
|
+
listTools() {
|
|
69
|
+
return this.run("listTools", () => this.raw.listTools());
|
|
70
|
+
}
|
|
71
|
+
callTool(name, args) {
|
|
72
|
+
return this.run(
|
|
73
|
+
`callTool:${name}`,
|
|
74
|
+
() => this.raw.callTool({ name, arguments: args ?? {} })
|
|
75
|
+
);
|
|
76
|
+
}
|
|
77
|
+
listResources() {
|
|
78
|
+
return this.run("listResources", () => this.raw.listResources());
|
|
79
|
+
}
|
|
80
|
+
readResource(uri) {
|
|
81
|
+
return this.run(`readResource:${uri}`, () => this.raw.readResource({ uri }));
|
|
82
|
+
}
|
|
83
|
+
listPrompts() {
|
|
84
|
+
return this.run("listPrompts", () => this.raw.listPrompts());
|
|
85
|
+
}
|
|
86
|
+
getPrompt(name, args) {
|
|
87
|
+
return this.run(
|
|
88
|
+
`getPrompt:${name}`,
|
|
89
|
+
() => this.raw.getPrompt({ name, arguments: args ?? {} })
|
|
90
|
+
);
|
|
91
|
+
}
|
|
92
|
+
};
|
|
93
|
+
async function createMCPClient(opts) {
|
|
94
|
+
const client = new MCPClient(opts);
|
|
95
|
+
await client.connect();
|
|
96
|
+
return client;
|
|
97
|
+
}
|
|
98
|
+
export {
|
|
99
|
+
MCPClient,
|
|
100
|
+
createMCPClient,
|
|
101
|
+
MCPClient as default
|
|
102
|
+
};
|
|
103
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/transport.ts"],"sourcesContent":["import { Client } from \"@modelcontextprotocol/sdk/client/index.js\";\r\nimport type {\r\n CallToolResult,\r\n GetPromptResult,\r\n ListPromptsResult,\r\n ListResourcesResult,\r\n ListToolsResult,\r\n ReadResourceResult,\r\n} from \"@modelcontextprotocol/sdk/types.js\";\r\nimport {\r\n createConsoleLogger,\r\n noopLogger,\r\n withRetry,\r\n type AuthConfig,\r\n type Logger,\r\n type LogLevel,\r\n type RetryOptions,\r\n type TransportConfig,\r\n} from \"@ubuligan/shared\";\r\nimport { buildTransport } from \"./transport.js\";\r\n\r\nexport type {\r\n AuthConfig,\r\n HttpTransportConfig,\r\n Logger,\r\n LogLevel,\r\n RetryOptions,\r\n StdioTransportConfig,\r\n TransportConfig,\r\n} from \"@ubuligan/shared\";\r\n\r\nexport interface MCPClientOptions {\r\n /** How to reach the server (stdio or Streamable HTTP). */\r\n transport: TransportConfig;\r\n /** Optional auth applied to HTTP transports. */\r\n auth?: AuthConfig;\r\n /** Retry policy applied to every request. Set `retries: 1` to disable. */\r\n retry?: RetryOptions;\r\n /** Provide a custom logger, or a level for the built-in console logger. */\r\n logger?: Logger | LogLevel;\r\n /** Client identity advertised to the server. */\r\n name?: string;\r\n version?: string;\r\n}\r\n\r\nfunction resolveLogger(logger: MCPClientOptions[\"logger\"]): Logger {\r\n if (!logger) return noopLogger;\r\n if (typeof logger === \"string\") return createConsoleLogger(logger);\r\n return logger;\r\n}\r\n\r\n/**\r\n * A thin, ergonomic wrapper over the MCP SDK `Client`. Every request is wrapped\r\n * with retry + logging; transport and auth are config-driven. The underlying\r\n * SDK client is exposed as `.raw` for advanced use.\r\n */\r\nexport class MCPClient {\r\n readonly raw: Client;\r\n private connected = false;\r\n private readonly opts: MCPClientOptions;\r\n private readonly logger: Logger;\r\n\r\n constructor(opts: MCPClientOptions) {\r\n this.opts = opts;\r\n this.logger = resolveLogger(opts.logger);\r\n this.raw = new Client({\r\n name: opts.name ?? \"mcp-toolkit-client\",\r\n version: opts.version ?? \"0.1.0\",\r\n });\r\n }\r\n\r\n async connect(): Promise<this> {\r\n if (this.connected) return this;\r\n const transport = await buildTransport(this.opts.transport, this.opts.auth);\r\n this.logger.info(\"connecting\", { transport: this.opts.transport.type });\r\n await this.raw.connect(transport);\r\n this.connected = true;\r\n this.logger.info(\"connected\");\r\n return this;\r\n }\r\n\r\n async close(): Promise<void> {\r\n if (!this.connected) return;\r\n await this.raw.close();\r\n this.connected = false;\r\n this.logger.info(\"closed\");\r\n }\r\n\r\n private run<T>(label: string, fn: () => Promise<T>): Promise<T> {\r\n if (!this.connected) {\r\n throw new Error(\"MCPClient is not connected — call connect() first\");\r\n }\r\n return withRetry(fn, this.opts.retry, this.logger, label);\r\n }\r\n\r\n listTools(): Promise<ListToolsResult> {\r\n return this.run(\"listTools\", () => this.raw.listTools());\r\n }\r\n\r\n callTool(name: string, args?: Record<string, unknown>): Promise<CallToolResult> {\r\n return this.run(`callTool:${name}`, () =>\r\n this.raw.callTool({ name, arguments: args ?? {} }),\r\n ) as Promise<CallToolResult>;\r\n }\r\n\r\n listResources(): Promise<ListResourcesResult> {\r\n return this.run(\"listResources\", () => this.raw.listResources());\r\n }\r\n\r\n readResource(uri: string): Promise<ReadResourceResult> {\r\n return this.run(`readResource:${uri}`, () => this.raw.readResource({ uri }));\r\n }\r\n\r\n listPrompts(): Promise<ListPromptsResult> {\r\n return this.run(\"listPrompts\", () => this.raw.listPrompts());\r\n }\r\n\r\n getPrompt(name: string, args?: Record<string, string>): Promise<GetPromptResult> {\r\n return this.run(`getPrompt:${name}`, () =>\r\n this.raw.getPrompt({ name, arguments: args ?? {} }),\r\n );\r\n }\r\n}\r\n\r\n/** Create and connect an {@link MCPClient} in one call. */\r\nexport async function createMCPClient(opts: MCPClientOptions): Promise<MCPClient> {\r\n const client = new MCPClient(opts);\r\n await client.connect();\r\n return client;\r\n}\r\n\r\nexport { MCPClient as default };\r\n","import { StdioClientTransport } from \"@modelcontextprotocol/sdk/client/stdio.js\";\r\nimport { StreamableHTTPClientTransport } from \"@modelcontextprotocol/sdk/client/streamableHttp.js\";\r\nimport type { Transport } from \"@modelcontextprotocol/sdk/shared/transport.js\";\r\nimport { resolveAuthHeaders, type AuthConfig, type TransportConfig } from \"@ubuligan/shared\";\r\n\r\n/**\r\n * Build an MCP SDK transport from a plain config object. stdio is for local\r\n * servers; http uses Streamable HTTP (the production transport — SSE is\r\n * deprecated upstream).\r\n */\r\nexport async function buildTransport(config: TransportConfig, auth?: AuthConfig): Promise<Transport> {\r\n if (config.type === \"stdio\") {\r\n return new StdioClientTransport({\r\n command: config.command,\r\n args: config.args,\r\n cwd: config.cwd,\r\n env: { ...(process.env as Record<string, string>), ...(config.env ?? {}) },\r\n });\r\n }\r\n\r\n const headers = { ...(await resolveAuthHeaders(auth)), ...(config.headers ?? {}) };\r\n return new StreamableHTTPClientTransport(new URL(config.url), {\r\n requestInit: { headers },\r\n });\r\n}\r\n"],"mappings":";AAAC,SAAS,cAAc;AASxB;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OAMK;;;AClBN,SAAS,4BAA4B;AACtC,SAAS,qCAAqC;AAE9C,SAAS,0BAAiE;AAO1E,eAAsB,eAAe,QAAyB,MAAuC;AACnG,MAAI,OAAO,SAAS,SAAS;AAC3B,WAAO,IAAI,qBAAqB;AAAA,MAC9B,SAAS,OAAO;AAAA,MAChB,MAAM,OAAO;AAAA,MACb,KAAK,OAAO;AAAA,MACZ,KAAK,EAAE,GAAI,QAAQ,KAAgC,GAAI,OAAO,OAAO,CAAC,EAAG;AAAA,IAC3E,CAAC;AAAA,EACH;AAEA,QAAM,UAAU,EAAE,GAAI,MAAM,mBAAmB,IAAI,GAAI,GAAI,OAAO,WAAW,CAAC,EAAG;AACjF,SAAO,IAAI,8BAA8B,IAAI,IAAI,OAAO,GAAG,GAAG;AAAA,IAC5D,aAAa,EAAE,QAAQ;AAAA,EACzB,CAAC;AACH;;;ADqBA,SAAS,cAAc,QAA4C;AACjE,MAAI,CAAC,OAAQ,QAAO;AACpB,MAAI,OAAO,WAAW,SAAU,QAAO,oBAAoB,MAAM;AACjE,SAAO;AACT;AAOO,IAAM,YAAN,MAAgB;AAAA,EACZ;AAAA,EACD,YAAY;AAAA,EACH;AAAA,EACA;AAAA,EAEjB,YAAY,MAAwB;AAClC,SAAK,OAAO;AACZ,SAAK,SAAS,cAAc,KAAK,MAAM;AACvC,SAAK,MAAM,IAAI,OAAO;AAAA,MACpB,MAAM,KAAK,QAAQ;AAAA,MACnB,SAAS,KAAK,WAAW;AAAA,IAC3B,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,UAAyB;AAC7B,QAAI,KAAK,UAAW,QAAO;AAC3B,UAAM,YAAY,MAAM,eAAe,KAAK,KAAK,WAAW,KAAK,KAAK,IAAI;AAC1E,SAAK,OAAO,KAAK,cAAc,EAAE,WAAW,KAAK,KAAK,UAAU,KAAK,CAAC;AACtE,UAAM,KAAK,IAAI,QAAQ,SAAS;AAChC,SAAK,YAAY;AACjB,SAAK,OAAO,KAAK,WAAW;AAC5B,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,QAAuB;AAC3B,QAAI,CAAC,KAAK,UAAW;AACrB,UAAM,KAAK,IAAI,MAAM;AACrB,SAAK,YAAY;AACjB,SAAK,OAAO,KAAK,QAAQ;AAAA,EAC3B;AAAA,EAEQ,IAAO,OAAe,IAAkC;AAC9D,QAAI,CAAC,KAAK,WAAW;AACnB,YAAM,IAAI,MAAM,kEAAqD;AAAA,IACvE;AACA,WAAO,UAAU,IAAI,KAAK,KAAK,OAAO,KAAK,QAAQ,KAAK;AAAA,EAC1D;AAAA,EAEA,YAAsC;AACpC,WAAO,KAAK,IAAI,aAAa,MAAM,KAAK,IAAI,UAAU,CAAC;AAAA,EACzD;AAAA,EAEA,SAAS,MAAc,MAAyD;AAC9E,WAAO,KAAK;AAAA,MAAI,YAAY,IAAI;AAAA,MAAI,MAClC,KAAK,IAAI,SAAS,EAAE,MAAM,WAAW,QAAQ,CAAC,EAAE,CAAC;AAAA,IACnD;AAAA,EACF;AAAA,EAEA,gBAA8C;AAC5C,WAAO,KAAK,IAAI,iBAAiB,MAAM,KAAK,IAAI,cAAc,CAAC;AAAA,EACjE;AAAA,EAEA,aAAa,KAA0C;AACrD,WAAO,KAAK,IAAI,gBAAgB,GAAG,IAAI,MAAM,KAAK,IAAI,aAAa,EAAE,IAAI,CAAC,CAAC;AAAA,EAC7E;AAAA,EAEA,cAA0C;AACxC,WAAO,KAAK,IAAI,eAAe,MAAM,KAAK,IAAI,YAAY,CAAC;AAAA,EAC7D;AAAA,EAEA,UAAU,MAAc,MAAyD;AAC/E,WAAO,KAAK;AAAA,MAAI,aAAa,IAAI;AAAA,MAAI,MACnC,KAAK,IAAI,UAAU,EAAE,MAAM,WAAW,QAAQ,CAAC,EAAE,CAAC;AAAA,IACpD;AAAA,EACF;AACF;AAGA,eAAsB,gBAAgB,MAA4C;AAChF,QAAM,SAAS,IAAI,UAAU,IAAI;AACjC,QAAM,OAAO,QAAQ;AACrB,SAAO;AACT;","names":[]}
|
package/package.json
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@ubuligan/client",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Thin DX layer over the MCP SDK Client: transport helpers, auth, retry and logging",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"license": "MIT",
|
|
7
|
+
"exports": {
|
|
8
|
+
".": {
|
|
9
|
+
"types": "./dist/index.d.ts",
|
|
10
|
+
"import": "./dist/index.js"
|
|
11
|
+
}
|
|
12
|
+
},
|
|
13
|
+
"main": "./dist/index.js",
|
|
14
|
+
"types": "./dist/index.d.ts",
|
|
15
|
+
"files": [
|
|
16
|
+
"dist",
|
|
17
|
+
"LICENSE"
|
|
18
|
+
],
|
|
19
|
+
"dependencies": {
|
|
20
|
+
"@modelcontextprotocol/sdk": "^1.29.0",
|
|
21
|
+
"@ubuligan/shared": "^0.1.0"
|
|
22
|
+
},
|
|
23
|
+
"devDependencies": {
|
|
24
|
+
"typescript": "^5.7.2",
|
|
25
|
+
"tsup": "^8.3.5"
|
|
26
|
+
},
|
|
27
|
+
"publishConfig": {
|
|
28
|
+
"access": "public"
|
|
29
|
+
},
|
|
30
|
+
"author": "jsznpm",
|
|
31
|
+
"homepage": "https://github.com/jsznpm/create-mcp-toolkit#readme",
|
|
32
|
+
"bugs": {
|
|
33
|
+
"url": "https://github.com/jsznpm/create-mcp-toolkit/issues"
|
|
34
|
+
},
|
|
35
|
+
"repository": {
|
|
36
|
+
"type": "git",
|
|
37
|
+
"url": "git+https://github.com/jsznpm/create-mcp-toolkit.git",
|
|
38
|
+
"directory": "packages/client"
|
|
39
|
+
},
|
|
40
|
+
"keywords": [
|
|
41
|
+
"mcp",
|
|
42
|
+
"model-context-protocol",
|
|
43
|
+
"ai",
|
|
44
|
+
"llm",
|
|
45
|
+
"client",
|
|
46
|
+
"sdk"
|
|
47
|
+
],
|
|
48
|
+
"scripts": {
|
|
49
|
+
"build": "tsup",
|
|
50
|
+
"typecheck": "tsc --noEmit"
|
|
51
|
+
}
|
|
52
|
+
}
|