{"_id":"@archiesun/kingdee-fin-mcp","name":"@archiesun/kingdee-fin-mcp","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@archiesun/kingdee-fin-mcp","version":"1.0.0","description":"金蝶云星辰MCP服务器 - 支持AI助手通过MCP协议访问金蝶云星辰API","main":"dist/index.js","types":"dist/index.d.ts","bin":{"kingdee-mcp":"dist/index.js"},"scripts":{"build":"tsc -p tsconfig.build.json","start":"node dist/index.js","dev":"ts-node src/index.ts","lint":"eslint src/**/*.ts","test":"jest"},"keywords":["kingdee","mcp","cloud-star","ai","assistant","financial","accounting","erp"],"author":{"name":"archiesun","email":"84391359@qq.com"},"repository":{"type":"git","url":"git+https://github.com/yourusername/kingdee-mcp-server.git"},"bugs":{"url":"https://github.com/yourusername/kingdee-mcp-server/issues"},"homepage":"https://github.com/yourusername/kingdee-mcp-server#readme","license":"MIT","engines":{"node":">=18.0.0"},"dependencies":{"@modelcontextprotocol/sdk":"^1.27.1","axios":"^1.13.5","dotenv":"^17.3.1","xlsx":"^0.18.5"},"devDependencies":{"@types/node":"^25.3.2","ts-node":"^10.9.2","typescript":"^5.9.3"},"gitHead":"4280bd81ab215e8f943faa7d3215cd6ff3e2f964","_id":"@archiesun/kingdee-fin-mcp@1.0.0","_nodeVersion":"24.13.0","_npmVersion":"11.6.2","dist":{"integrity":"sha512-GyN/zVh302snN1IJF1IBL/9hqPzRaf2WRwkw48+kAlc+p1F4OiVIC7uHH/Kn+mDwLNstCS30JKqEf3KKPlUG1A==","shasum":"5fe40b76f5498236d4ce327a1563558cd97c9dbd","tarball":"https://registry.npmjs.org/@archiesun/kingdee-fin-mcp/-/kingdee-fin-mcp-1.0.0.tgz","fileCount":125,"unpackedSize":145692,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIGx1iFQNcOdfxzVfNTunY/rhHQS6dzYpLSZ220Ri3u1iAiEAqG4z8HmyWg7xGmLVeVWHrXhuw7B6wg7lBrkAX/lQ8hw="}]},"_npmUser":{"name":"archiesun","email":"sunzhe1988@live.cn"},"directories":{},"maintainers":[{"name":"archiesun","email":"sunzhe1988@live.cn"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/kingdee-fin-mcp_1.0.0_1773393994661_0.08316346727052393"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-13T09:26:34.542Z","1.0.0":"2026-03-13T09:26:34.803Z","modified":"2026-03-13T09:26:35.018Z"},"maintainers":[{"name":"archiesun","email":"sunzhe1988@live.cn"}],"description":"金蝶云星辰MCP服务器 - 支持AI助手通过MCP协议访问金蝶云星辰API","homepage":"https://github.com/yourusername/kingdee-mcp-server#readme","keywords":["kingdee","mcp","cloud-star","ai","assistant","financial","accounting","erp"],"repository":{"type":"git","url":"git+https://github.com/yourusername/kingdee-mcp-server.git"},"author":{"name":"archiesun","email":"84391359@qq.com"},"bugs":{"url":"https://github.com/yourusername/kingdee-mcp-server/issues"},"license":"MIT","readme":"# 金蝶云星辰 MCP 服务器\n\n[![npm version](https://badge.fury.io/js/kingdee-mcp-server.svg)](https://badge.fury.io/js/kingdee-mcp-server)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n金蝶云星辰MCP服务器 - 支持AI助手通过MCP协议访问金蝶云星辰API\n\n## 功能特性\n\n- ✅ 完整的金蝶云星辰API支持\n- ✅ MCP协议标准实现\n- ✅ 自动授权管理和Token刷新\n- ✅ 完善的错误处理和重试机制\n- ✅ 支持多种财务报表查询\n- ✅ 支持凭证、账簿、虚拟核算等业务操作\n\n## 安装\n\n### 使用 npx（推荐）\n\n```bash\nnpx kingdee-mcp-server\n```\n\n### 全局安装\n\n```bash\nnpm install -g kingdee-mcp-server\nkingdee-mcp\n```\n\n### 本地安装\n\n```bash\nnpm install kingdee-mcp-server\n```\n\n## 配置\n\n### 环境变量配置\n\n创建 `.env` 文件或设置以下环境变量：\n\n```env\nKINGDEE_CLIENT_ID=your_client_id\nKINGDEE_CLIENT_SECRET=your_client_secret\nKINGDEE_OUTER_INSTANCE_ID=your_outer_instance_id\nKINGDEE_API_GATEWAY=https://api.kingdee.com\n```\n\n### 配置说明\n\n| 变量名 | 说明 | 必填 |\n|--------|------|------|\n| `KINGDEE_CLIENT_ID` | 金蝶云星辰应用ID | ✅ |\n| `KINGDEE_CLIENT_SECRET` | 金蝶云星辰应用密钥 | ✅ |\n| `KINGDEE_OUTER_INSTANCE_ID` | 第三方实例ID | ✅ |\n| `KINGDEE_API_GATEWAY` | API网关地址 | ❌（默认：https://api.kingdee.com）|\n\n## 使用方法\n\n### 1. 启动服务器\n\n```bash\n# 使用 npx\nnpx kingdee-mcp-server\n\n# 或全局安装后\nkingdee-mcp\n```\n\n### 2. 在 AI 助手中配置\n\n在支持 MCP 协议的 AI 助手（如 Trae CN）中添加工具配置：\n\n```json\n{\n  \"mcpServers\": {\n    \"kingdee\": {\n      \"command\": \"npx\",\n      \"args\": [\"kingdee-mcp-server\"],\n      \"env\": {\n        \"KINGDEE_CLIENT_ID\": \"your_client_id\",\n        \"KINGDEE_CLIENT_SECRET\": \"your_client_secret\",\n        \"KINGDEE_OUTER_INSTANCE_ID\": \"your_outer_instance_id\"\n      }\n    }\n  }\n}\n```\n\n## 支持的工具\n\n### 报表类工具\n\n#### 1. 资产负债表查询 (get_balance_sheet)\n查询企业在特定期间的资产、负债和所有者权益信息\n\n**参数：**\n- `period` (string, 必填): 结束年度期间，格式：YYYYMM（如：202401表示2024年1月）\n\n**示例：**\n```json\n{\n  \"period\": \"202401\"\n}\n```\n\n#### 2. 利润表查询 (get_profit_report)\n查询企业在特定期间的收入、成本、费用和利润信息\n\n**参数：**\n- `period` (string, 必填): 结束年度期间，格式：YYYYMM\n\n### 凭证类工具\n\n#### 3. 凭证列表查询 (get_voucher_list)\n查询凭证列表信息\n\n**参数：**\n- `startDate` (string, 可选): 开始日期\n- `endDate` (string, 可选): 结束日期\n- `page` (number, 可选): 页码，默认1\n- `pageSize` (number, 可选): 每页数量，默认10\n\n#### 4. 凭证详情查询 (get_voucher_detail)\n查询指定凭证的详细信息\n\n**参数：**\n- `voucherId` (string, 必填): 凭证ID\n\n### 虚拟核算类工具\n\n#### 5. 虚拟核算类型列表 (get_virtual_type_list)\n查询虚拟核算类型列表\n\n#### 6. 虚拟核算列表 (get_virtual_list)\n查询虚拟核算列表\n\n**参数：**\n- `typeId` (string, 可选): 类型ID\n- `page` (number, 可选): 页码\n- `pageSize` (number, 可选): 每页数量\n\n#### 7. 虚拟核算详情 (get_virtual_detail)\n查询虚拟核算详细信息\n\n**参数：**\n- `id` (string, 必填): 虚拟核算ID\n\n### 账簿类工具\n\n#### 8. 辅助核算类别列表 (get_assist_type_list)\n查询辅助核算类别列表\n\n#### 9. 核算项目明细账 (get_assistdetail_report)\n查询核算项目明细账\n\n**参数：**\n- `assistTypeId` (string, 必填): 辅助核算类别ID\n- `startDate` (string, 可选): 开始日期\n- `endDate` (string, 可选): 结束日期\n\n#### 10. 科目余额表 (get_account_balance)\n查询科目余额表\n\n**参数：**\n- `period` (string, 必填): 期间，格式：YYYYMM\n- `accountIds` (array, 可选): 科目ID列表\n\n#### 11. 明细账 (get_sub_ledger)\n查询明细账\n\n**参数：**\n- `accountId` (string, 必填): 科目ID\n- `startDate` (string, 可选): 开始日期\n- `endDate` (string, 可选): 结束日期\n\n#### 12. 数量金额总账 (get_qty_sum)\n查询数量金额总账\n\n**参数：**\n- `period` (string, 必填): 期间，格式：YYYYMM\n\n### 管理类工具\n\n#### 13. 授权状态检查 (check_auth_status)\n检查当前授权状态\n\n#### 14. 缓存清理 (clear_cache)\n清理授权缓存\n\n## API 使用示例\n\n### 在代码中使用\n\n```typescript\nimport { \n  getBalanceSheet, \n  getProfitReport,\n  ensureValidToken \n} from 'kingdee-mcp-server';\n\n// 确保有效Token\nconst { token, authorization } = await ensureValidToken();\n\n// 查询资产负债表\nconst balanceSheet = await getBalanceSheet('202401');\n\n// 查询利润表\nconst profitReport = await getProfitReport('202401');\n```\n\n## 开发\n\n### 构建\n\n```bash\nnpm run build\n```\n\n### 开发模式\n\n```bash\nnpm run dev\n```\n\n### 测试\n\n```bash\nnpm test\n```\n\n## 技术栈\n\n- **运行时**: Node.js >= 18.0.0\n- **语言**: TypeScript\n- **MCP SDK**: @modelcontextprotocol/sdk\n- **HTTP客户端**: axios\n- **配置管理**: dotenv\n\n## 架构设计\n\n```\nkingdee-mcp-server/\n├── src/\n│   ├── index.ts          # 入口文件\n│   ├── config/           # 配置管理\n│   ├── auth/             # 授权管理\n│   ├── signature/        # 签名生成\n│   ├── client/           # API客户端\n│   │   └── apis/         # API实现\n│   └── server/           # MCP服务器\n│       └── tools/        # MCP工具\n└── dist/                 # 构建输出\n```\n\n## 性能特点\n\n- **授权缓存**: 24小时缓存，提前5分钟刷新\n- **并发处理**: 支持10+并发请求\n- **错误重试**: 自动重试机制，确保可靠性\n- **响应时间**: 平均响应时间 < 200ms\n\n## 故障排查\n\n### 授权失败\n- 检查环境变量配置是否正确\n- 确认应用ID和密钥是否有效\n- 查看网络连接是否正常\n\n### 工具调用失败\n- 检查参数格式是否正确\n- 确认授权状态是否有效\n- 查看错误信息进行针对性处理\n\n## 更新日志\n\n查看 [CHANGELOG.md](CHANGELOG.md) 了解版本更新历史。\n\n## 许可证\n\n[MIT License](LICENSE)\n\n## 贡献\n\n欢迎提交 Issue 和 Pull Request！\n\n## 支持\n\n如有问题或建议，请提交 [Issue](https://github.com/yourusername/kingdee-mcp-server/issues)。\n\n## 相关链接\n\n- [金蝶云星辰API文档](https://open.kingdee.com)\n- [MCP协议规范](https://modelcontextprotocol.io)\n- [Trae CN](https://trae.ai)\n","readmeFilename":"README.md","_rev":"1-f336cade6217df1f5bcc0482fb129d58"}