feat: export all chart schema & call tool function (#81)

* feat: export all chart schema & call tool function

* chore: fix typo of english

* refactor: chart schema should be an object

* test: add test cases for utils

Author: hustcc

__tests__/api.spec.ts

@@ -0,0 +1,38 @@
+import { afterEach, describe, expect, it } from "vitest";
+import * as API from "../src/sdk";
+
+describe("sdk API", () => {
+  it("callTool", () => {
+    expect(API.callTool).instanceOf(Function);
+  });
+
+  it("chart meta", () => {
+    const { callTool, ...charts } = API;
+    expect(Object.keys(charts)).toEqual([
+      "area",
+      "bar",
+      "column",
+      "fishbone-diagram",
+      "flow-diagram",
+      "histogram",
+      "line",
+      "mind-map",
+      "network-graph",
+      "pie",
+      "radar",
+      "scatter",
+      "treemap",
+      "word-cloud",
+      "dual-axes",
+    ]);
+  });
+
+  it("chart meta structure", () => {
+    const { area } = API;
+    expect(area.schema).toBeTypeOf("object");
+    expect(area.tool).toBeTypeOf("object");
+    expect(area.tool.name).toBeTypeOf("string");
+    expect(area.tool.description).toBeTypeOf("string");
+    expect(area.tool.inputSchema).toBeTypeOf("object");
+  });
+});

__tests__/charts.spec.ts renamed to __tests__/charts/charts.spec.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from "vitest";
-import * as actualCharts from "../src/charts";
-import * as expectedCharts from "./charts";
+import * as expectedCharts from ".";
+import * as actualCharts from "../../src/charts";
 
 describe("charts schema check", () => {
   // Get the chart names from the rightCharts module

__tests__/utils/validators.spec.ts renamed to __tests__/constant.ts

@@ -1,7 +1,4 @@
-import { describe, expect, it } from "vitest";
-import * as Charts from "../../src/charts";
-
-const mindMapSchema = {
+export const MindMapSchema = {
   type: "mind-map",
   data: {
     name: "剪映视频剪辑指南",
@@ -172,7 +169,7 @@ const mindMapSchema = {
   source: "mcp-server-chart",
 };
 
-const flowDiagramSchema = {
+export const FlowDiagramSchema = {
   type: "network-graph",
   data: {
     nodes: [
@@ -266,25 +263,3 @@ const flowDiagramSchema = {
   height: 600,
   source: "mcp-server-chart",
 };
-
-describe("valid", () => {
-  // Valid mind map bad case
-  it("should valid schema for mind-map chart", () => {
-    const chartType = "mind-map";
-    expect(() => {
-      const schema = Charts[chartType].schema;
-      schema.safeParse(mindMapSchema);
-    }).toThrow("Invalid parameters: node name '文字动画' is not unique.");
-  });
-
-  // Valid flow diagram bad case
-  it("should valid schema for flow diagram chart", () => {
-    const chartType = "flow-diagram";
-    expect(() => {
-      const schema = Charts[chartType].schema;
-      schema.safeParse(flowDiagramSchema);
-    }).toThrow(
-      "Invalid parameters: edge pair 'KnowledgeBase-Model' is not unique.",
-    );
-  });
-});

__tests__/utils/env.spec.ts

@@ -0,0 +1,20 @@
+import { afterEach, describe, expect, it } from "vitest";
+import { getVisRequestServer } from "../../src/utils/env";
+
+describe("env", () => {
+  it("default vis request server", () => {
+    expect(getVisRequestServer()).toBe(
+      "https://antv-studio.alipay.com/api/gpt-vis",
+    );
+  });
+
+  it("modify vis request server by env", () => {
+    process.env.VIS_REQUEST_SERVER = "https://example.com/api/gpt-vis";
+    expect(getVisRequestServer()).toBe("https://example.com/api/gpt-vis");
+  });
+
+  afterEach(() => {
+    process.env.VIS_REQUEST_SERVER =
+      "https://antv-studio.alipay.com/api/gpt-vis";
+  });
+});

__tests__/utils/schema.spec.ts

@@ -0,0 +1,30 @@
+import { afterEach, describe, expect, it } from "vitest";
+import { z } from "zod";
+import { zodToJsonSchema } from "../../src/utils/schema";
+
+describe("schema", () => {
+  it("default vis request server", () => {
+    expect(
+      zodToJsonSchema({
+        a: z.number(),
+        b: z.string(),
+        c: z.boolean(),
+      }),
+    ).toEqual({
+      $schema: "http://json-schema.org/draft-07/schema#",
+      properties: {
+        a: {
+          type: "number",
+        },
+        b: {
+          type: "string",
+        },
+        c: {
+          type: "boolean",
+        },
+      },
+      required: ["a", "b", "c"],
+      type: "object",
+    });
+  });
+});

__tests__/utils/validator.spec.ts

@@ -0,0 +1,24 @@
+import { describe, expect, it } from "vitest";
+import { z } from "zod";
+import * as Charts from "../../src/charts";
+import { FlowDiagramSchema, MindMapSchema } from "../constant";
+
+describe("validator", () => {
+  it("should valid schema for mind-map chart", () => {
+    const chartType = "mind-map";
+    expect(() => {
+      const schema = Charts[chartType].schema;
+      z.object(schema).safeParse(MindMapSchema);
+    }).toThrow("Invalid parameters: node's name '文字动画' should be unique.");
+  });
+
+  it("should valid schema for flow diagram chart", () => {
+    const chartType = "flow-diagram";
+    expect(() => {
+      const schema = Charts[chartType].schema;
+      z.object(schema).safeParse(FlowDiagramSchema);
+    }).toThrow(
+      "Invalid parameters: edge pair 'KnowledgeBase-Model' should be unique.",
+    );
+  });
+});

package.json

@@ -1,9 +1,12 @@
 {
   "name": "@antv/mcp-server-chart",
   "description": "A Model Context Protocol server for generating charts using AntV, This is a TypeScript-based MCP server that provides chart generation capabilities. It allows you to create various types of charts through MCP tools.",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "main": "build/index.js",
   "type": "module",
+  "exports": {
+    "./sdk": "./build/sdk.js"
+  },
   "scripts": {
     "prebuild": "rm -rf build/*",
     "build": "tsc && tsc-alias -p tsconfig.json",

src/charts/area.ts

@@ -17,7 +17,7 @@ const data = z.object({
 });
 
 // Area chart input schema
-const schema = z.object({
+const schema = {
   data: z
     .array(data)
     .describe("Data for area chart, such as, [{ time: '2018', value: 99.9 }].")
@@ -35,7 +35,7 @@ const schema = z.object({
   title: TitleSchema,
   axisXTitle: AxisXTitleSchema,
   axisYTitle: AxisYTitleSchema,
-});
+};
 
 // Area chart tool descriptor
 const tool = {

src/charts/bar.ts

@@ -17,7 +17,7 @@ const data = z.object({
 });
 
 // Bar chart input schema
-const schema = z.object({
+const schema = {
   data: z
     .array(data)
     .describe(
@@ -44,7 +44,7 @@ const schema = z.object({
   title: TitleSchema,
   axisXTitle: AxisXTitleSchema,
   axisYTitle: AxisYTitleSchema,
-});
+};
 
 // Bar chart tool descriptor
 const tool = {

src/charts/column.ts

@@ -17,7 +17,7 @@ const data = z.object({
 });
 
 // Column chart input schema
-const schema = z.object({
+const schema = {
   data: z
     .array(data)
     .describe(
@@ -44,7 +44,7 @@ const schema = z.object({
   title: TitleSchema,
   axisXTitle: AxisXTitleSchema,
   axisYTitle: AxisYTitleSchema,
-});
+};
 
 // Column chart tool descriptor
 const tool = {