@cnbcool/mcp-server 0.4.0-beta.0 → 0.4.0-beta.2

package/README.md

@@ -2,30 +2,46 @@
 
 CNB(https://cnb.cool) toolkits for LLMs supporting the MCP protocol
 
-## Online Preview
+## How to use
+
+### STDIO
+
+```json
+{
+  "mcpServers": {
+    "cnb": {
+      "command": "npx",
+      "args": ["-y", "-p", "@cnbcool/mcp-server", "cnb-mcp-stdio"],
+      "env": {
+        "API_BASE_URL": "<BASE_URL>", // optional, defualt vaule: https://api.cnb.cool
+        "API_TOKEN": "<YOUR_TOKEN>"
+      }
+    }
+  }
+}
+```
 
-https://cnb.cool/examples/ecosystem/cnb-mcp-client-with-ollama
 
 ## Prerequisite
 
 1. node >= 18
-2. typescript >=5.5
 
 ## How to develop
 
 1. `npm install`
 2. `npx openapi-typescript@5.4.2 https://api.cnb.cool/swagger.json -o src/schema.d.ts`
-3. Rename `.env.example` to `.env` and fill in the values
-4. `npm build`
-5. `npx @modelcontextprotocol/inspector -e API_TOKEN=xxxxxxxxxx node dist/stdio.js`
+3. Copy `.env.example` and rename to `.env` and fill in the values
+4. `npm run build`
+5. `npx @modelcontextprotocol/inspector node dist/stdio.js`
 
 > @modelcontextprotocol/inspector requires Node.js: ^22.7.5
 
 > https://github.com/modelcontextprotocol/inspector?tab=readme-ov-file#requirements
 
-## How to configure
+## How to preview
 
-### Local
+1. npm run build
+2. set mcpServers config:
 
 ```json
 {
@@ -42,19 +58,4 @@ https://cnb.cool/examples/ecosystem/cnb-mcp-client-with-ollama
 }
 ```
 
-### Production
 
-```json
-{
-  "mcpServers": {
-    "cnb": {
-      "command": "npx",
-      "args": ["-y", "@cnbcool/mcp-server"],
-      "env": {
-        "API_BASE_URL": "<BASE_URL>",
-        "API_TOKEN": "<YOUR_TOKEN>"
-      }
-    }
-  }
-}
-```

package/dist/tools/issueTools.js

@@ -3,29 +3,31 @@ 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().default(1).describe('第几页，从1开始'),
-        page_size: z.number().default(10).describe('每页多少条数据'),
+        page: z.number().default(1).describe('第几页,从1开始'),
+        page_size: z.number().default(10).describe('每页多少条数据,默认是30'),
         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 优先级'),
+        priority: z
+            .preprocess((val) => (val === null ? undefined : val), z.string().optional())
+            .describe('Issue 优先级,example: p0,p1,p2,p3'),
         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 作者的名字'),
+            .describe('Issue 作者的名字, example: 张三,李四'),
         assignees: z
             .preprocess((val) => (val === null ? undefined : val), z.string().optional())
-            .describe('Issue 处理人'),
+            .describe('Issue 处理人,example: 张三,李四,-; - means assign to nobody'),
         updated_time_begin: z
             .preprocess((val) => (val === null ? undefined : val), z.string().optional())
-            .describe('Issue 更新时间的范围，开始时间点'),
+            .describe('Issue 更新时间的范围,开始时间点,example: 2022-01-31'),
         updated_time_end: z
             .preprocess((val) => (val === null ? undefined : val), z.string().optional())
-            .describe('Issue 更新时间的范围，结束时间点'),
+            .describe('Issue 更新时间的范围,结束时间点,example: 2022-01-31'),
         order_by: z
             .preprocess((val) => (val === null ? undefined : val), z.string().optional())
-            .describe('Issue 排序顺序')
+            .describe('Issue 排序顺序.example: created_at, -updated_at, reference_count。‘-’ prefix means descending order')
     }, 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, {

package/dist/tools/repoTools.js

@@ -2,19 +2,21 @@ import { z } from 'zod';
 import { getRepository, listGroupRepositories, listRepositories } from '../api/repository.js';
 export default function registerRepoTools(server) {
     server.tool('list-repositories', '获取当前用户拥有指定权限及其以上权限的仓库', {
-        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('仓库关键字'),
+        page: z.number().default(1).describe('第几页,从1开始,默认值是1'),
+        page_size: z.number().default(10).describe('每页多少条数据,默认值为10'),
+        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('仓库类型'),
+            .describe('仓库类型,为空表示所有仓库类型,默认值为空'),
         role: z
             .preprocess((val) => (val === null ? undefined : val), z.enum(['Reporter', 'Developer', 'Master', 'Owner']).optional())
-            .describe('最小仓库权限'),
+            .describe('最小仓库权限,当用户未指定角色时,需要主动传入Reporter'),
         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('排序顺序')
+            .describe('排序类型,默认值是last_updated_at'),
+        desc: z
+            .preprocess((val) => (val === null ? undefined : val), z.boolean().optional())
+            .describe('是否开启倒叙排序，默认值是false')
     }, 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 });
@@ -41,8 +43,8 @@ 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(10).describe('每页多少条数据'),
+        page: z.number().default(1).describe('第几页,从1开始,默认值是1'),
+        page_size: z.number().default(10).describe('每页多少条数据,默认值为10'),
         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())
@@ -53,7 +55,9 @@ export default function registerRepoTools(server) {
         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('排序顺序')
+        desc: z
+            .preprocess((val) => (val === null ? undefined : val), z.boolean().optional())
+            .describe('是否开启倒叙排序，默认值是false')
     }, async ({ group, page, page_size, search, filter_type, descendant, order_by, desc }) => {
         try {
             const repos = await listGroupRepositories(group, {

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.4.0-beta.0",
+  "version": "0.4.0-beta.2",
   "main": "./dist/stdio.js",
   "bin": {
     "cnb-mcp-stdio": "dist/stdio.js",
@@ -14,7 +14,9 @@
     "start": "node dist/stdio.js",
     "prepare": "husky",
     "lint": "eslint src",
-    "format": "prettier --check src"
+    "lint:fix": "eslint --fix src",
+    "format:check": "prettier --check src",
+    "format:fix": "prettier --write src"
   },
   "repository": {
     "type": "git",
@@ -47,6 +49,7 @@
     "@commitlint/cli": "19.8.0",
     "@commitlint/config-conventional": "19.8.0",
     "@eslint/js": "9.24.0",
+    "@modelcontextprotocol/inspector": "^0.11.0",
     "@types/express": "5.0.1",
     "@types/node": "22.13.9",
     "eslint": "9.24.0",