mcp-cnbs 1.0.2

package/License

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,226 @@
+# CNBS MCP Server
+
+MCP server for querying China National Bureau of Statistics data.
+
+## Installation
+
+### Use with npx (Recommended)
+
+```bash
+npx @icen.ai/mcp-cnbs
+```
+
+### Use with HTTP transport
+
+```bash
+npx @icen.ai/mcp-cnbs --port 12345
+```
+
+### Install globally
+
+```bash
+npm install -g @icen.ai/mcp-cnbs
+mcp-cnbs
+```
+
+## MCP Client Configuration
+
+### NPX Mode (Local)
+
+**Supported clients:** Claude Desktop, Cursor, Windsurf, Cherry Studio, Trae, Continue, and other MCP clients.
+
+Add to your MCP client configuration file:
+
+```json
+{
+  "mcpServers": {
+    "cnbs": {
+      "command": "npx",
+      "args": ["@icen.ai/mcp-cnbs"]
+    }
+  }
+}
+```
+
+### HTTP Mode (Remote Access)
+
+**Supported clients:** Trae, Cherry Studio, and other MCP clients with HTTP transport support.
+
+**Free Demo on ModelScope (recommended):**
+```json
+{
+  "mcpServers": {
+    "cnbs": {
+      "url": "https://mcp.api-inference.modelscope.net/3d34f0e0c26a44/mcp"
+    }
+  }
+}
+```
+
+> **Note:** This is a free public demo provided by Alibaba Cloud ModelScope. No authentication required.
+>
+> Since free services may change, we recommend deploying your own instance: [Deploy on ModelScope](https://modelscope.cn/mcp/servers/thatcoder/cnbs)
+
+## Endpoints
+
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/` | POST | Streamable HTTP (recommended) |
+| `/` | GET | SSE stream for notifications |
+| `/sse` | GET | Legacy SSE mode |
+| `/message` | POST | Legacy SSE messages |
+
+## Tools
+
+### Data Query
+
+| Tool | Description |
+|------|-------------|
+| `cnbs_search` | Search by keyword, returns latest data value |
+| `cnbs_fetch_nodes` | Get category tree nodes |
+| `cnbs_fetch_metrics` | Get indicator list for a dataset |
+| `cnbs_fetch_series` | Get time series data |
+| `cnbs_fetch_end_nodes` | Recursively get all leaf nodes |
+| `cnbs_batch_search` | Batch search multiple keywords |
+| `cnbs_compare` | Compare data across regions or time periods |
+
+### Reference Data
+
+| Tool | Description |
+|------|-------------|
+| `cnbs_get_regions` | Get available region codes and names |
+| `cnbs_get_categories` | Get all data category information |
+
+### Utilities
+
+| Tool | Description |
+|------|-------------|
+| `cnbs_get_guide` | Get usage guide |
+| `cnbs_get_cache_stats` | Get cache statistics |
+| `cnbs_format_number` | Format numbers |
+| `cnbs_transform_unit` | Unit conversion |
+| `cnbs_compute_stats` | Compute statistics |
+
+## Quick Examples
+
+```
+// Search GDP
+cnbs_search(keyword="GDP")
+
+// Search birth rate
+cnbs_search(keyword="出生率")
+
+// Batch search
+cnbs_batch_search(keywords=["GDP", "CPI", "人口"])
+
+// Compare regions
+cnbs_compare(keyword="GDP", regions=["北京", "上海"], compareType="region")
+
+// Get region codes
+cnbs_get_regions(keyword="广东")
+```
+
+## Notes
+
+`cnbs_search` returns `value` field with data. `cnbs_fetch_series` may return empty `value` - this is an API limitation.
+
+For latest values, use `cnbs_search`.
+
+## Category Codes
+
+| Code | Category |
+|------|----------|
+| 1 | Monthly |
+| 2 | Quarterly |
+| 3 | Yearly |
+| 5 | Provincial Quarterly |
+| 6 | Provincial Yearly |
+| 7 | Other |
+| 8 | Major Cities Yearly |
+| 9 | Hong Kong/Macau/Taiwan Monthly |
+| 10 | Hong Kong/Macau/Taiwan Yearly |
+
+## Time Format
+
+- Yearly: `2024YY`, range `["2020YY-2024YY"]`
+- Quarterly: `2024A/B/C/D`, shortcuts `LAST6/LAST12/LAST18`
+- Monthly: `202401MM`, range `["202301MM-202412MM"]`
+
+## Region Codes
+
+Region codes follow GB/T 2260 standard. Use `cnbs_get_regions` to get the full list.
+
+Examples:
+- Beijing: `110000000000`
+- Shanghai: `310000000000`
+- Guangdong: `440000000000`
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Build
+npm run build
+
+# Run locally
+npm run start
+
+# Development mode with watch
+npm run dev
+```
+
+## Authentication
+
+By default, no authentication is required. You can enable authentication using Bearer token.
+
+### Local / HTTP Mode
+
+```bash
+# Using command line argument
+npx @icen.ai/mcp-cnbs --port 12345 --auth-token your-secret-token
+
+# Using environment variable
+MCP_CNBS_AUTH_TOKEN=your-secret-token npx @icen.ai/mcp-cnbs --port 12345
+```
+
+When authentication is enabled, requests must include:
+```
+Authorization: Bearer your-secret-token
+```
+
+### Cloudflare Workers
+
+Set `MCP_CNBS_AUTH_TOKEN` in Cloudflare dashboard secrets:
+
+```bash
+# Deploy with secret
+npx wrangler secret put MCP_CNBS_AUTH_TOKEN
+# Enter your token when prompted
+
+# Or use wrangler.toml
+# (secrets cannot be set in wrangler.toml for security)
+```
+
+### MCP Client Configuration with Auth
+
+```json
+{
+  "mcpServers": {
+    "cnbs": {
+      "command": "npx",
+      "args": ["@icen.ai/mcp-cnbs", "--port", "12345", "--auth-token", "your-secret-token"]
+    }
+  }
+}
+```
+
+## Requirements
+
+- Node.js >= 18.0.0
+- Network access to `data.stats.gov.cn`
+
+## License
+
+MIT

package/README.zh-CN.md

@@ -0,0 +1,225 @@
+# CNBS MCP 服务器
+
+国家统计局数据查询的 MCP 服务器。
+
+## 安装使用
+
+### npx 直接运行（推荐）
+
+```bash
+npx @icen.ai/mcp-cnbs
+```
+
+### HTTP 模式
+
+```bash
+npx @icen.ai/mcp-cnbs --port 12345
+```
+
+### 全局安装
+
+```bash
+npm install -g @icen.ai/mcp-cnbs
+mcp-cnbs
+```
+
+## MCP 客户端配置
+
+### NPX 模式（本地运行）
+
+**支持的客户端：** Claude Desktop、Cursor、Windsurf、Cherry Studio、Trae、Continue 等所有支持 MCP 的客户端。
+
+添加到 MCP 客户端配置文件：
+
+```json
+{
+  "mcpServers": {
+    "cnbs": {
+      "command": "npx",
+      "args": ["@icen.ai/mcp-cnbs"]
+    }
+  }
+}
+```
+
+### HTTP 模式（远程访问）
+
+**支持的客户端：** Trae、Cherry Studio 等支持 HTTP transport 的客户端。
+
+**魔搭免费演示（推荐）：**
+```json
+{
+  "mcpServers": {
+    "cnbs": {
+      "url": "https://mcp.api-inference.modelscope.net/3d34f0e0c26a44/mcp"
+    }
+  }
+}
+```
+
+> **注意：** 这是阿里云 ModelScope 提供的免费公共演示服务，无需认证。
+>
+> 由于免费服务可能变更，建议自行部署：[在魔搭免费部署](https://modelscope.cn/mcp/servers/thatcoder/cnbs)
+
+## 端点说明
+
+| 端点 | 方法 | 说明 |
+|------|------|------|
+| `/` | POST | Streamable HTTP（推荐） |
+| `/` | GET | SSE 流（通知） |
+| `/sse` | GET | 旧版 SSE 模式 |
+| `/message` | POST | 旧版 SSE 消息 |
+
+## 工具列表
+
+### 数据查询
+
+| 工具 | 功能 |
+|------|------|
+| `cnbs_search` | 关键词搜索，返回最新数据值 |
+| `cnbs_fetch_nodes` | 获取分类树节点 |
+| `cnbs_fetch_metrics` | 获取数据集的指标列表 |
+| `cnbs_fetch_series` | 获取时间序列数据 |
+| `cnbs_fetch_end_nodes` | 递归获取所有叶子节点 |
+| `cnbs_batch_search` | 批量搜索多个关键词 |
+| `cnbs_compare` | 数据对比（地区对比/时间对比） |
+
+### 参考数据
+
+| 工具 | 功能 |
+|------|------|
+| `cnbs_get_regions` | 获取地区代码列表 |
+| `cnbs_get_categories` | 获取所有分类信息 |
+
+### 辅助功能
+
+| 工具 | 功能 |
+|------|------|
+| `cnbs_get_guide` | 获取使用指南 |
+| `cnbs_get_cache_stats` | 获取缓存统计 |
+| `cnbs_format_number` | 格式化数字 |
+| `cnbs_transform_unit` | 单位转换 |
+| `cnbs_compute_stats` | 计算统计信息 |
+
+## 快速示例
+
+```
+// 查询 GDP
+cnbs_search(keyword="GDP")
+
+// 查询出生率
+cnbs_search(keyword="出生率")
+
+// 批量查询
+cnbs_batch_search(keywords=["GDP", "CPI", "人口"])
+
+// 地区对比
+cnbs_compare(keyword="GDP", regions=["北京", "上海"], compareType="region")
+
+// 获取地区代码
+cnbs_get_regions(keyword="广东")
+```
+
+## 说明
+
+`cnbs_search` 返回的 `value` 字段有值。`cnbs_fetch_series` 返回的 `value` 字段可能为空，这是国家统计局 API 的限制。
+
+只需最新值时，用 `cnbs_search`。
+
+## 分类代码
+
+| 代码 | 分类 |
+|------|------|
+| 1 | 月度数据 |
+| 2 | 季度数据 |
+| 3 | 年度数据 |
+| 5 | 分省季度 |
+| 6 | 分省年度 |
+| 7 | 其他 |
+| 8 | 主要城市年度 |
+| 9 | 港澳台月度 |
+| 10 | 港澳台年度 |
+
+## 时间格式
+
+- 年度: `2024YY`, 范围 `["2020YY-2024YY"]`
+- 季度: `2024A/B/C/D`, 快捷范围 `LAST6/LAST12/LAST18`
+- 月度: `202401MM`, 范围 `["202301MM-202412MM"]`
+
+## 地区代码
+
+地区代码遵循 GB/T 2260 标准。使用 `cnbs_get_regions` 获取完整列表。
+
+示例:
+- 北京: `110000000000`
+- 上海: `310000000000`
+- 广东: `440000000000`
+
+## 开发
+
+```bash
+# 安装依赖
+npm install
+
+# 编译
+npm run build
+
+# 运行
+npm run start
+
+# 开发模式
+npm run dev
+```
+
+## 鉴权配置
+
+默认无需鉴权。可通过 Bearer Token 启用鉴权。
+
+### 本地 / HTTP 模式
+
+```bash
+# 命令行参数
+npx @icen.ai/mcp-cnbs --port 12345 --auth-token your-secret-token
+
+# 环境变量
+MCP_CNBS_AUTH_TOKEN=your-secret-token npx @icen.ai/mcp-cnbs --port 12345
+```
+
+启用鉴权后，请求需包含：
+```
+Authorization: Bearer your-secret-token
+```
+
+### Cloudflare Workers
+
+在 Cloudflare 控制台设置密钥：
+
+```bash
+# 部署时设置密钥
+npx wrangler secret put MCP_CNBS_AUTH_TOKEN
+# 按提示输入 token
+
+# 注意：出于安全考虑，密钥不能在 wrangler.toml 中设置
+```
+
+### 带鉴权的 MCP 客户端配置
+
+```json
+{
+  "mcpServers": {
+    "cnbs": {
+      "command": "npx",
+      "args": ["@icen.ai/mcp-cnbs", "--port", "12345", "--auth-token", "your-secret-token"]
+    }
+  }
+}
+```
+
+## 环境要求
+
+- Node.js >= 18.0.0
+- 网络能访问 `data.stats.gov.cn`
+
+## 许可证
+
+MIT

package/dist/constants/index.d.ts

@@ -0,0 +1,3 @@
+export * from './regions.js';
+export * from '../constants.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/constants/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC"}

package/dist/constants/index.js

@@ -0,0 +1,3 @@
+export * from './regions.js';
+export * from '../constants.js';
+//# sourceMappingURL=index.js.map

package/dist/constants/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC"}

package/dist/constants/regions.d.ts

@@ -0,0 +1,16 @@
+export interface CnbsRegion {
+    code: string;
+    name: string;
+    shortName: string;
+    level: 'province' | 'city' | 'county';
+}
+export declare const CNBS_REGIONS: CnbsRegion[];
+export declare const CNBS_CATEGORY_INFO: Record<string, {
+    name: string;
+    code: string;
+    dtType: string;
+}>;
+export declare function getRegionByCode(code: string): CnbsRegion | undefined;
+export declare function getRegionByName(name: string): CnbsRegion | undefined;
+export declare function searchRegions(keyword: string): CnbsRegion[];
+//# sourceMappingURL=regions.d.ts.map

package/dist/constants/regions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"regions.d.ts","sourceRoot":"","sources":["../../src/constants/regions.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,CAAC;CACvC;AAED,eAAO,MAAM,YAAY,EAAE,UAAU,EAoCpC,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAc7F,CAAC;AAEF,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAEpE;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAOpE;AAED,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,EAAE,CAO3D"}