@cnbcool/mcp-server 0.3.0 → 0.3.2

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 0.3.2 (May 6, 2025)
+
+### New Features
+
+- Supports list groups with various filters
+- Supports list sub-groups with various filters
+- Supports get group details
+- Supports create group
+- Supports create repository
+
+## 0.3.1 (April 23, 2025)
+
+### New Features
+
+- Bump to @modelcontextprotocol/sdk 1.10.2
+- Add zod preprocess, convert null to undefined
+
 ## 0.3.0 (April 23, 2025)
 
 ### New Features

package/README.md

@@ -19,6 +19,10 @@ https://cnb.cool/examples/ecosystem/cnb-mcp-client-with-ollama
 4. `npm build`
 5. `npx @modelcontextprotocol/inspector -e API_TOKEN=xxxxxxxxxx node dist/index.js`
 
+> @modelcontextprotocol/inspector requires Node.js: ^22.7.5
+
+> https://github.com/modelcontextprotocol/inspector?tab=readme-ov-file#requirements
+
 ## How to configure
 
 ### Local

package/dist/api/group.js

@@ -0,0 +1,40 @@
+import CnbApiClient from './client.js';
+export async function listGroups(params) {
+    const cnbInst = CnbApiClient.getInstance();
+    const url = new URL('/user/groups', cnbInst.baseUrl);
+    if (params) {
+        for (const [key, value] of Object.entries(params)) {
+            if (value === undefined)
+                continue;
+            url.searchParams.set(key, value.toString());
+        }
+    }
+    return cnbInst.request('GET', `${url.pathname}${url.search}`);
+}
+export async function listSubGroups(group, params) {
+    const cnbInst = CnbApiClient.getInstance();
+    const url = new URL(`/user/groups/${group}`, cnbInst.baseUrl);
+    if (params) {
+        for (const [key, value] of Object.entries(params)) {
+            if (value === undefined)
+                continue;
+            url.searchParams.set(key, value.toString());
+        }
+    }
+    return cnbInst.request('GET', `${url.pathname}${url.search}`);
+}
+export async function getGroup(group) {
+    const cnbInst = CnbApiClient.getInstance();
+    return cnbInst.request('GET', `/${group}`);
+}
+export async function createGroup(params) {
+    const body = Object.entries(params).reduce((acc, [key, value]) => {
+        if (value === undefined)
+            return acc;
+        Object.assign(acc, { [key]: value });
+        return acc;
+    }, {});
+    return CnbApiClient.getInstance().request('POST', '/groups', body, {
+        header: { 'Content-Type': 'application/json' }
+    });
+}

package/dist/api/repository.js

@@ -26,3 +26,14 @@ export async function listGroupRepositories(group, params) {
 export async function getRepository(repo) {
     return CnbApiClient.getInstance().request('GET', `/${repo}`);
 }
+export async function createRepository(group, params) {
+    const body = Object.entries(params).reduce((acc, [key, value]) => {
+        if (value === undefined)
+            return acc;
+        Object.assign(acc, { [key]: value });
+        return acc;
+    }, {});
+    return CnbApiClient.getInstance().request('POST', `/${group}/-/repos`, body, {
+        header: { 'Content-Type': 'application/json' }
+    });
+}

package/dist/api/user.js

@@ -0,0 +1,5 @@
+import CnbApiClient from './client.js';
+export async function getUser() {
+    const cnbInst = CnbApiClient.getInstance();
+    return cnbInst.request('GET', '/user');
+}

package/dist/tools/groupTools.js

@@ -0,0 +1,121 @@
+import { z } from 'zod';
+import { createGroup, getGroup, listGroups, listSubGroups } from '../api/group.js';
+export default function registerGroupTools(server) {
+    server.tool('list-groups', '获取当前用户拥有权限的顶层组织列表', {
+        page: z.number().default(1).describe('第几页，从1开始'),
+        page_size: z.number().default(10).describe('每页多少条数据'),
+        search: z.preprocess((val) => (val === null ? undefined : val), z.string().optional()).describe('仓库关键字'),
+        role: z
+            .preprocess((val) => (val === null ? undefined : val), z.enum(['Guest', 'Reporter', 'Developer', 'Master', 'Owner']).optional())
+            .describe('最小仓库权限')
+    }, async ({ page, page_size, search, role }) => {
+        try {
+            const repos = await listGroups({ page, page_size, search, role });
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: JSON.stringify(repos, null, 2)
+                    }
+                ]
+            };
+        }
+        catch (error) {
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: `Error listing repositories: ${error instanceof Error ? error.message : String(error)}`
+                    }
+                ],
+                isError: true
+            };
+        }
+    });
+    server.tool('list-sub-groups', '查询当前用户在指定组织下拥有指定权限的子组织列表', {
+        group: z.string().describe('组织名称'),
+        page: z.number().default(1).describe('第几页，从1开始'),
+        page_size: z.number().default(10).describe('每页多少条数据'),
+        access: z.preprocess((val) => (val === null ? undefined : val), z.number().optional()).describe('权限等级')
+    }, async ({ group, page, page_size, access }) => {
+        try {
+            const subGroups = await listSubGroups(group, { page, page_size, access });
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: JSON.stringify(subGroups, null, 2)
+                    }
+                ]
+            };
+        }
+        catch (error) {
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: `Error listing repositories: ${error instanceof Error ? error.message : String(error)}`
+                    }
+                ],
+                isError: true
+            };
+        }
+    });
+    server.tool('get-group', '获取指定组织信息', {
+        group: z.string().describe('组织路径')
+    }, async ({ group }) => {
+        try {
+            const data = await getGroup(group);
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: JSON.stringify(data, null, 2)
+                    }
+                ]
+            };
+        }
+        catch (error) {
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: `Error getting repository: ${error instanceof Error ? error.message : String(error)}`
+                    }
+                ],
+                isError: true
+            };
+        }
+    });
+    server.tool('create-group', '创建新组织', {
+        path: z.string().describe('组织路径'),
+        description: z.preprocess((val) => (val === null ? undefined : val), z.string().optional()).describe('组织描述'),
+        remark: z.preprocess((val) => (val === null ? undefined : val), z.string().optional()).describe('仓库备注'),
+        bind_domain: z
+            .preprocess((val) => (val === null ? undefined : val), z.string().optional())
+            .describe('根组织绑定的域名')
+    }, async ({ path, description, remark, bind_domain }) => {
+        try {
+            const data = await createGroup({ path, description, remark, bind_domain });
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: JSON.stringify(data, null, 2)
+                    }
+                ]
+            };
+        }
+        catch (error) {
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: `Error creating repository: ${error instanceof Error ? error.message : String(error)}`
+                    }
+                ],
+                isError: true
+            };
+        }
+    });
+}

package/dist/tools/index.js

@@ -1,4 +1,5 @@
 import CnbApiClient from '../api/client.js';
+import registerGroupTools from './groupTools.js';
 import registerRepoTools from './repoTools.js';
 import registerIssueTools from './issueTools.js';
 import registerWorkspaceTools from './workspaceTools.js';
@@ -7,6 +8,7 @@ export function registerTools(server) {
         baseUrl: process.env.API_BASE_URL || 'https://api.cnb.cool',
         token: process.env.API_TOKEN || ''
     });
+    registerGroupTools(server);
     registerRepoTools(server);
     registerIssueTools(server);
     registerWorkspaceTools(server);

package/dist/tools/issueTools.js

@@ -3,17 +3,29 @@ import { createIssue, getIssue, listIssues } from '../api/issue.js';
 export default function registerIssueTools(server) {
     server.tool('list-issues', '查询仓库的 Issues', {
         repo: z.string().describe('仓库路径'),
-        page: z.number().optional().describe('第几页，从1开始'),
-        page_size: z.number().optional().describe('每页多少条数据'),
-        state: z.enum(['open', 'closed']).optional().describe('Issue 状态'),
-        keyword: z.string().optional().describe('Issue 关键字'),
-        priority: z.string().optional().describe('Issue 优先级'),
-        labels: z.string().optional().describe('Issue 标签'),
-        authors: z.string().optional().describe('Issue 作者的名字'),
-        assignees: z.string().optional().describe('Issue 处理人'),
-        updated_time_begin: z.string().optional().describe('Issue 更新时间的范围，开始时间点'),
-        updated_time_end: z.string().optional().describe('Issue 更新时间的范围，结束时间点'),
-        order_by: z.string().optional().describe('Issue 排序顺序')
+        page: z.number().default(1).describe('第几页，从1开始'),
+        page_size: z.number().default(10).describe('每页多少条数据'),
+        state: z
+            .preprocess((val) => (val === null ? undefined : val), z.enum(['open', 'closed']).optional())
+            .describe('Issue 状态'),
+        keyword: z.preprocess((val) => (val === null ? undefined : val), z.string().optional()).describe('Issue 关键字'),
+        priority: z.preprocess((val) => (val === null ? undefined : val), z.string().optional()).describe('Issue 优先级'),
+        labels: z.preprocess((val) => (val === null ? undefined : val), z.string().optional()).describe('Issue 标签'),
+        authors: z
+            .preprocess((val) => (val === null ? undefined : val), z.string().optional())
+            .describe('Issue 作者的名字'),
+        assignees: z
+            .preprocess((val) => (val === null ? undefined : val), z.string().optional())
+            .describe('Issue 处理人'),
+        updated_time_begin: z
+            .preprocess((val) => (val === null ? undefined : val), z.string().optional())
+            .describe('Issue 更新时间的范围，开始时间点'),
+        updated_time_end: z
+            .preprocess((val) => (val === null ? undefined : val), z.string().optional())
+            .describe('Issue 更新时间的范围，结束时间点'),
+        order_by: z
+            .preprocess((val) => (val === null ? undefined : val), z.string().optional())
+            .describe('Issue 排序顺序')
     }, async ({ repo, page, page_size, state, keyword, priority, labels, authors, assignees, updated_time_begin, updated_time_end, order_by }) => {
         try {
             const issues = await listIssues(repo, {
@@ -80,10 +92,14 @@ export default function registerIssueTools(server) {
     server.tool('create-issue', '创建一个 Issue', {
         repo: z.string().describe('仓库路径'),
         title: z.string().describe('Issue 标题'),
-        body: z.string().optional().describe('Issue 描述'),
-        assignees: z.array(z.string()).optional().describe('一个或多个 Issue 处理人的用户名'),
-        labels: z.array(z.string()).optional().describe('一个或多个 Issue 标签'),
-        priority: z.string().optional().describe('Issue 优先级')
+        body: z.preprocess((val) => (val === null ? undefined : val), z.string().optional()).describe('Issue 描述'),
+        assignees: z
+            .preprocess((val) => (val === null ? undefined : val), z.array(z.string()).optional())
+            .describe('一个或多个 Issue 处理人的用户名'),
+        labels: z
+            .preprocess((val) => (val === null ? undefined : val), z.array(z.string()).optional())
+            .describe('一个或多个 Issue 标签'),
+        priority: z.preprocess((val) => (val === null ? undefined : val), z.string().optional()).describe('Issue 优先级')
     }, async ({ repo, title, body, assignees, labels, priority }) => {
         try {
             const issue = await createIssue(repo, {

package/dist/tools/repoTools.js

@@ -1,14 +1,21 @@
 import { z } from 'zod';
-import { getRepository, listGroupRepositories, listRepositories } from '../api/repository.js';
+import { createRepository, getRepository, listGroupRepositories, listRepositories } from '../api/repository.js';
+import { getUser } from '../api/user.js';
 export default function registerRepoTools(server) {
     server.tool('list-repositories', '获取当前用户拥有指定权限及其以上权限的仓库', {
         page: z.number().default(1).describe('第几页，从1开始'),
-        page_size: z.number().default(20).describe('每页多少条数据'),
-        search: z.string().optional().describe('仓库关键字'),
-        filter_type: z.enum(['private', 'public', 'encrypted']).optional().describe('仓库类型'),
-        role: z.enum(['Reporter', 'Developer', 'Master', 'Owner']).optional().describe('最小仓库权限'),
-        order_by: z.enum(['created_at', 'last_updated_at', 'stars']).optional().describe('排序类型'),
-        desc: z.boolean().optional().describe('排序顺序')
+        page_size: z.number().default(10).describe('每页多少条数据'),
+        search: z.preprocess((val) => (val === null ? undefined : val), z.string().optional()).describe('仓库关键字'),
+        filter_type: z
+            .preprocess((val) => (val === null ? undefined : val), z.enum(['private', 'public', 'encrypted']).optional())
+            .describe('仓库类型'),
+        role: z
+            .preprocess((val) => (val === null ? undefined : val), z.enum(['Reporter', 'Developer', 'Master', 'Owner']).optional())
+            .describe('最小仓库权限'),
+        order_by: z
+            .preprocess((val) => (val === null ? undefined : val), z.enum(['created_at', 'last_updated_at', 'stars']).optional())
+            .describe('排序类型'),
+        desc: z.preprocess((val) => (val === null ? undefined : val), z.boolean().optional()).describe('排序顺序')
     }, async ({ page, page_size, search, filter_type, role, order_by, desc }) => {
         try {
             const repos = await listRepositories({ page, page_size, search, filter_type, role, order_by, desc });
@@ -36,12 +43,18 @@ export default function registerRepoTools(server) {
     server.tool('list-group-repositories', '获取分组里当前用户有权限的仓库', {
         group: z.string().describe('组织名称'),
         page: z.number().default(1).describe('第几页，从1开始'),
-        page_size: z.number().default(20).describe('每页多少条数据'),
-        search: z.string().optional().describe('仓库关键字'),
-        filter_type: z.enum(['private', 'public', 'encrypted']).optional().describe('仓库类型'),
-        descendant: z.enum(['all', 'sub', 'grand']).optional().describe('查全部、直接属于当前组织的仓库、子组织的仓库'),
-        order_by: z.enum(['created_at', 'last_updated_at', 'stars', 'slug_path']).optional().describe('排序类型'),
-        desc: z.boolean().optional().describe('排序顺序')
+        page_size: z.number().default(10).describe('每页多少条数据'),
+        search: z.preprocess((val) => (val === null ? undefined : val), z.string().optional()).describe('仓库关键字'),
+        filter_type: z
+            .preprocess((val) => (val === null ? undefined : val), z.enum(['private', 'public', 'encrypted']).optional())
+            .describe('仓库类型'),
+        descendant: z
+            .preprocess((val) => (val === null ? undefined : val), z.enum(['all', 'sub', 'grand']).optional())
+            .describe('查全部、直接属于当前组织的仓库、子组织的仓库'),
+        order_by: z
+            .preprocess((val) => (val === null ? undefined : val), z.enum(['created_at', 'last_updated_at', 'stars', 'slug_path']).optional())
+            .describe('排序类型'),
+        desc: z.preprocess((val) => (val === null ? undefined : val), z.boolean().optional()).describe('排序顺序')
     }, async ({ group, page, page_size, search, filter_type, descendant, order_by, desc }) => {
         try {
             const repos = await listGroupRepositories(group, {
@@ -75,15 +88,15 @@ export default function registerRepoTools(server) {
         }
     });
     server.tool('get-repository', '获取指定仓库信息', {
-        repoId: z.string().describe('仓库 ID')
-    }, async ({ repoId }) => {
+        repo: z.string().describe('仓库路径')
+    }, async ({ repo }) => {
         try {
-            const repo = await getRepository(repoId);
+            const data = await getRepository(repo);
             return {
                 content: [
                     {
                         type: 'text',
-                        text: JSON.stringify(repo, null, 2)
+                        text: JSON.stringify(data, null, 2)
                     }
                 ]
             };
@@ -100,4 +113,41 @@ export default function registerRepoTools(server) {
             };
         }
     });
+    server.tool('create-repository', '创建仓库', {
+        group: z.preprocess((val) => (val === null ? undefined : val), z.string().optional()).describe('仓库所属分组'),
+        name: z.string().describe('仓库名称'),
+        description: z.preprocess((val) => (val === null ? undefined : val), z.string().optional()).describe('仓库描述'),
+        license: z.preprocess((val) => (val === null ? undefined : val), z.string().optional()).describe('仓库许可'),
+        visibility: z
+            .preprocess((val) => (val === null ? undefined : val), z.enum(['public', 'private', 'secret']).default('public'))
+            .describe('仓库可见性')
+    }, async ({ group, name, description, license, visibility }) => {
+        let repoGroup = group;
+        if (!repoGroup) {
+            const { username = '' } = await getUser();
+            repoGroup = username;
+        }
+        try {
+            const data = await createRepository(repoGroup, { name, description, license, visibility });
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: JSON.stringify(data, null, 2)
+                    }
+                ]
+            };
+        }
+        catch (error) {
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: `Error creating repository: ${error instanceof Error ? error.message : String(error)}`
+                    }
+                ],
+                isError: true
+            };
+        }
+    });
 }

package/dist/tools/workspaceTools.js

@@ -2,18 +2,26 @@ import { z } from 'zod';
 import { deleteWorkspace, listWorkspace } from '../api/workspace.js';
 export default function registerWorkspaceTools(server) {
     server.tool('list-workspace', '获取我的云原生开发环境列表', {
-        branch: z.string().optional().describe('分支名，例如：main'),
+        branch: z
+            .preprocess((val) => (val === null ? undefined : val), z.string().optional())
+            .describe('分支名，例如：main'),
         start: z
-            .string()
-            .optional()
+            .preprocess((val) => (val === null ? undefined : val), z.string().optional())
             .describe('查询结束时间，格式：YYYY-MM-DD HH:mm:ssZZ，例如：2024-12-01 00:00:00+0800'),
-        end: z.string().optional().describe('查询开始时间，格式：YYYY-MM-DD HH:mm:ssZZ，例如：2024-12-01 00:00:00+0800'),
-        page: z.number().optional().describe('分页页码，从 1 开始，默认为 1'),
-        page_size: z.number().optional().describe('每页条数，默认为 20，最高 100'),
-        slug: z.string().optional().describe('仓库路径，例如：groupname/reponame'),
+        end: z
+            .preprocess((val) => (val === null ? undefined : val), z.string().optional())
+            .describe('查询开始时间，格式：YYYY-MM-DD HH:mm:ssZZ，例如：2024-12-01 00:00:00+0800'),
+        page: z
+            .preprocess((val) => (val === null ? undefined : val), z.number().optional())
+            .describe('分页页码，从 1 开始，默认为 1'),
+        page_size: z
+            .preprocess((val) => (val === null ? undefined : val), z.number().optional())
+            .describe('每页条数，默认为 20，最高 100'),
+        slug: z
+            .preprocess((val) => (val === null ? undefined : val), z.string().optional())
+            .describe('仓库路径，例如：groupname/reponame'),
         status: z
-            .enum(['running', 'closed'])
-            .optional()
+            .preprocess((val) => (val === null ? undefined : val), z.enum(['running', 'closed']).optional())
             .describe('开发环境状态，running: 开发环境已启动，closed：开发环境已关闭，默认为所有状态')
     }, async ({ branch, page, page_size, start, end, slug, status }) => {
         try {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cnbcool/mcp-server",
   "description": "CNB MCP Server. A comprehensive MCP server that provides seamless integration to the CNB's API(https://cnb.cool), offering a wide range of tools for repository management, pipelines operations and collaboration features",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "main": "./dist/index.js",
   "bin": {
     "cnb-mcp-server": "dist/index.js"
@@ -37,9 +37,9 @@
     "typescript": ">=5.5"
   },
   "dependencies": {
-    "@modelcontextprotocol/sdk": "1.6.1",
-    "dotenv": "16.4.7",
-    "zod": "3.24.2"
+    "@modelcontextprotocol/sdk": "1.10.2",
+    "dotenv": "16.5.0",
+    "zod": "3.24.3"
   },
   "devDependencies": {
     "@commitlint/cli": "19.8.0",