@brander/mcp-tools 0.2.0 → 0.2.2
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/README.md +6 -4
- package/dist/server/brand/brand-loader.js +1 -1
- package/dist/server/config/server-config.js +1 -1
- package/dist/server/config/types.d.ts +1 -1
- package/dist/server/config/types.d.ts.map +1 -1
- package/dist/server/register.d.ts +1 -1
- package/dist/server/register.d.ts.map +1 -1
- package/dist/server/register.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Add branded, interactive UI to any MCP server in one line.
|
|
4
4
|
|
|
5
|
-
`@brander/mcp-tools` registers a `generate_screen` tool on your MCP server that renders
|
|
5
|
+
`@brander/mcp-tools` registers a `generate_screen` tool on your MCP server that renders built-in and custom element types (charts, tables, grids, forms, and more) with your brand's colors, fonts, and styling — directly inside Claude Desktop.
|
|
6
6
|
|
|
7
7
|
## Quick Start
|
|
8
8
|
|
|
@@ -38,7 +38,7 @@ When you call `registerBranderTools(server, config)`, it adds:
|
|
|
38
38
|
|
|
39
39
|
Your brand settings (colors, fonts, layout, dark mode) are loaded from the BranderUX API at startup and applied to every rendered screen.
|
|
40
40
|
|
|
41
|
-
##
|
|
41
|
+
## Built-in Element Types
|
|
42
42
|
|
|
43
43
|
| Element | Description |
|
|
44
44
|
|---|---|
|
|
@@ -57,6 +57,8 @@ Your brand settings (colors, fonts, layout, dark mode) are loaded from the Brand
|
|
|
57
57
|
| `button` | Action/link button |
|
|
58
58
|
| `alert` | Notification banner |
|
|
59
59
|
|
|
60
|
+
You can also create custom element types through the [BranderUX dashboard](https://branderux.com).
|
|
61
|
+
|
|
60
62
|
## Configuration
|
|
61
63
|
|
|
62
64
|
```typescript
|
|
@@ -67,7 +69,7 @@ interface BranderToolsConfig {
|
|
|
67
69
|
/** Beta design partner key (bux_dp_xxx) */
|
|
68
70
|
betaKey: string;
|
|
69
71
|
|
|
70
|
-
/** API base URL (defaults to https://
|
|
72
|
+
/** API base URL (defaults to https://branderux.com) */
|
|
71
73
|
apiBaseUrl?: string;
|
|
72
74
|
|
|
73
75
|
/** Path to local brandSettings.json for development */
|
|
@@ -95,7 +97,7 @@ interface BranderToolsConfig {
|
|
|
95
97
|
## How It Works
|
|
96
98
|
|
|
97
99
|
1. At startup, `registerBranderTools` loads your project's brand settings from the BranderUX API
|
|
98
|
-
2. It registers the `generate_screen` tool with Zod schemas for all
|
|
100
|
+
2. It registers the `generate_screen` tool with Zod schemas for all element types
|
|
99
101
|
3. It registers an MCP App resource — a single-file HTML bundle containing all React components
|
|
100
102
|
4. When Claude calls `generate_screen`, it returns structured data + a reference to the HTML resource
|
|
101
103
|
5. Claude Desktop loads the HTML resource and renders branded UI with your data
|
|
@@ -62,7 +62,7 @@ function loadConfigFromFile(filePath) {
|
|
|
62
62
|
}
|
|
63
63
|
/** Fetch full project config from the BranderUX API */
|
|
64
64
|
async function loadConfigFromApi(options) {
|
|
65
|
-
const baseUrl = options.apiBaseUrl || "https://
|
|
65
|
+
const baseUrl = options.apiBaseUrl || "https://branderux.com";
|
|
66
66
|
const url = new URL("/api/project/brand-settings", baseUrl);
|
|
67
67
|
url.searchParams.set("projectId", options.projectId);
|
|
68
68
|
url.searchParams.set("betaKey", options.betaKey);
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Server configuration loading — env vars, JSON file, or direct config.
|
|
3
3
|
*/
|
|
4
4
|
import { readFileSync, existsSync } from "fs";
|
|
5
|
-
const DEFAULT_API_BASE_URL = "https://
|
|
5
|
+
const DEFAULT_API_BASE_URL = "https://branderux.com";
|
|
6
6
|
const DEFAULT_SERVER_NAME = "brander-mcp";
|
|
7
7
|
const DEFAULT_SERVER_VERSION = "0.1.0";
|
|
8
8
|
/**
|
|
@@ -7,7 +7,7 @@ export interface BranderMCPServerConfig {
|
|
|
7
7
|
projectId: string;
|
|
8
8
|
/** Beta design partner key (bux_dp_xxx) for authentication */
|
|
9
9
|
betaKey: string;
|
|
10
|
-
/** BranderUX API base URL (defaults to https://
|
|
10
|
+
/** BranderUX API base URL (defaults to https://branderux.com) */
|
|
11
11
|
apiBaseUrl?: string;
|
|
12
12
|
/** Path to local brandSettings.json file (alternative to API for development) */
|
|
13
13
|
brandSettingsPath?: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/config/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,KAAK,CAAC;AAE5C,MAAM,WAAW,sBAAsB;IACrC,qEAAqE;IACrE,SAAS,EAAE,MAAM,CAAC;IAElB,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;IAEhB,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/config/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,KAAK,CAAC;AAE5C,MAAM,WAAW,sBAAsB;IACrC,qEAAqE;IACrE,SAAS,EAAE,MAAM,CAAC;IAElB,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;IAEhB,iEAAiE;IACjE,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,iFAAiF;IACjF,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,mDAAmD;IACnD,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,+CAA+C;IAC/C,SAAS,CAAC,EAAE,aAAa,CAAC;CAC3B"}
|
|
@@ -16,7 +16,7 @@ export interface BranderToolsConfig {
|
|
|
16
16
|
projectId: string;
|
|
17
17
|
/** Beta design partner key (bux_dp_xxx) for authentication */
|
|
18
18
|
betaKey: string;
|
|
19
|
-
/** BranderUX API base URL (defaults to https://
|
|
19
|
+
/** BranderUX API base URL (defaults to https://branderux.com) */
|
|
20
20
|
apiBaseUrl?: string;
|
|
21
21
|
/** Path to local brandSettings.json file (alternative to API for development) */
|
|
22
22
|
brandSettingsPath?: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../../src/register.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAQpE,MAAM,WAAW,kBAAkB;IACjC,gFAAgF;IAChF,SAAS,EAAE,MAAM,CAAC;IAElB,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;IAEhB,
|
|
1
|
+
{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../../src/register.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAQpE,MAAM,WAAW,kBAAkB;IACjC,gFAAgF;IAChF,SAAS,EAAE,MAAM,CAAC;IAElB,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;IAEhB,iEAAiE;IACjE,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,iFAAiF;IACjF,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;;;;;;;GASG;AACH,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,SAAS,EACjB,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,IAAI,CAAC,CA2Bf"}
|
package/dist/server/register.js
CHANGED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
import { loadProjectConfig } from "./brand/brand-loader.js";
|
|
14
14
|
import { registerTools } from "./tools/tool-registry.js";
|
|
15
15
|
import { registerAppResourceHandler } from "./resource/resource-registry.js";
|
|
16
|
-
const DEFAULT_API_BASE_URL = "https://
|
|
16
|
+
const DEFAULT_API_BASE_URL = "https://branderux.com";
|
|
17
17
|
/**
|
|
18
18
|
* Register BranderUX tools on an existing MCP server.
|
|
19
19
|
*
|