kingdee-k3cloud-mcp 0.1.0__tar.gz

kingdee_k3cloud_mcp-0.1.0/.env.example

@@ -0,0 +1,19 @@
+# 金蝶云星空 API 配置
+KD_ACCT_ID=your_acct_id
+KD_USERNAME=your_username
+KD_APP_ID=your_app_id
+KD_APP_SEC=your_app_secret
+KD_SERVER_URL=https://your-server/k3cloud/
+KD_LCID=2052
+KD_ORG_NUM=
+
+# SSE 传输模式（仅 --transport sse 时生效）
+# FASTMCP_HOST=127.0.0.1   # 绑定地址（0.0.0.0 可远程访问）
+# FASTMCP_PORT=8000         # 端口
+
+# Bearer Token 鉴权（仅 SSE/streamable-http 模式生效）
+# MCP_API_KEY=your-secret-api-key      # 不设置则不启用鉴权
+# MCP_ISSUER_URL=http://127.0.0.1:8000 # 与客户端连接地址一致（默认 http://localhost:8000）
+
+# 服务模式（readonly: 仅查询工具；readwrite: 全部工具，默认）
+# MCP_MODE=readwrite

kingdee_k3cloud_mcp-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set Python ${{ matrix.python-version }}
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Run tests
+        run: uv run --frozen pytest

kingdee_k3cloud_mcp-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: Release to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write   # required for PyPI Trusted Publishing (OIDC)
+      contents: write   # required to create GitHub Release
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: '3.12'
+
+      - run: uv sync --frozen
+
+      - run: uv build
+
+      - run: uv run --with twine twine check dist/*
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true
+          body_path: CHANGELOG.md

kingdee_k3cloud_mcp-0.1.0/.gitignore

@@ -0,0 +1,57 @@
+# ============================================================
+# 凭证与敏感配置（绝对不能提交）
+# ============================================================
+.env
+.env.*
+!.env.example
+*.env
+secrets/
+credentials/
+
+# ============================================================
+# Python
+# ============================================================
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.egg
+*.egg-info/
+dist/
+build/
+.eggs/
+
+# 虚拟环境
+.venv/
+venv/
+env/
+ENV/
+
+# 测试与覆盖率
+.pytest_cache/
+.coverage
+htmlcov/
+
+# uv
+.python-version
+
+# ============================================================
+# 编辑器与 IDE
+# ============================================================
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# ============================================================
+# macOS
+# ============================================================
+.DS_Store
+.AppleDouble
+._*
+
+# ============================================================
+# Claude Code 本地配置
+# ============================================================
+.claude/

kingdee_k3cloud_mcp-0.1.0/CHANGELOG.md

@@ -0,0 +1,52 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-04-12
+
+### Added
+
+**Core MCP tools (11 total)**
+
+| Tool | Type | Description |
+|------|------|-------------|
+| `query_bill` | query | 按字段键列表查询单据，支持过滤、排序、分页 |
+| `query_bill_json` | query | 查询单据并返回完整 JSON 字段（适合字段名未知时探索） |
+| `view_bill` | query | 按单据 ID 或单号查询单条完整单据 |
+| `query_metadata` | query | 查询表单元数据与字段定义 |
+| `query_by_number` | query | 批量按单号查询单据 |
+| `query_business_info` | query | 查询扩展业务数据视图 |
+| `save_bill` | write | 新建或更新单据 |
+| `submit_bill` | write | 提交单据审批 |
+| `audit_bill` | write | 审核通过单据 |
+| `unaudit_bill` | write | 撤销单据审核 |
+| `delete_bill` | write | 删除草稿单据 |
+| `execute_operation` | write | 调用金蝶 K/3 Cloud 任意业务操作 |
+| `push_bill` | write | 单据下推，将源单转换为下游单据类型 |
+
+**Transport & auth**
+- Three transport protocols: `stdio` (default), `SSE`, `streamable-http`
+- Optional Bearer-token authentication via `MCP_API_KEY` env var (SSE / streamable-http only); stdio mode is unaffected
+- `--mode readonly` flag (and `MCP_MODE=readonly` env var) to expose only the 4 query tools — safe for read-only deployments
+
+**Session management**
+- `RetryableK3CloudApiSdk`: automatic session recovery when K/3 Cloud returns "会话信息已丢失"
+- Fire-and-forget SID reset: on expiry, clears stale `cookiesStore` and makes one call to establish a fresh SID; returns the error immediately instead of blocking
+- 300-second cooldown prevents back-to-back resets from destroying a newly-issued SID before it activates server-side
+- Unicode-escaped session expiry messages correctly detected (`\u4f1a\u8bdd...`)
+- `hasattr` guard on `cookiesStore` reset for forward-compatibility with future SDK versions
+
+**Package & tooling**
+- Proper `src/` layout, fully PEP 621 compliant `pyproject.toml`
+- Dependency upper bounds: `kingdee-cdp-webapi-sdk>=8.2.0,<9`, `mcp>=1.26.0,<2`, `python-dotenv>=1.2.1,<2`
+- `py.typed` marker for downstream `mypy` support
+- Apache 2.0 license
+- GitHub Actions CI matrix (Python 3.10 / 3.11 / 3.12)
+- GitHub Actions release workflow with PyPI Trusted Publishing (OIDC)
+
+[0.1.0]: https://github.com/adamzhang1987/kingdee-k3cloud-mcp/releases/tag/v0.1.0

kingdee_k3cloud_mcp-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing to kingdee-k3cloud-mcp
+
+Thank you for your interest in contributing!
+
+## Prerequisites
+
+- Python 3.10+
+- [uv](https://docs.astral.sh/uv/)
+- Access to a Kingdee K3Cloud instance (for manual testing)
+
+## Setup
+
+```bash
+git clone https://github.com/adamzhang1987/kingdee-k3cloud-mcp.git
+cd kingdee-k3cloud-mcp
+uv sync
+```
+
+## Running Tests
+
+```bash
+uv run pytest
+```
+
+## Making Changes
+
+1. Fork the repo and create a feature branch from `main`
+2. Make your changes
+3. Add or update tests if applicable
+4. Run `uv run pytest` to ensure tests pass
+5. Submit a pull request
+
+## Reporting Issues
+
+Please open an issue with:
+- A clear description of the problem
+- Steps to reproduce
+- Expected vs actual behavior
+- Kingdee K3Cloud version if relevant
+
+## Security Issues
+
+Please do **not** open public issues for security vulnerabilities. See [SECURITY.md](SECURITY.md) instead.

kingdee_k3cloud_mcp-0.1.0/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 2026 Adam Zhang
+
+   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.

kingdee_k3cloud_mcp-0.1.0/PKG-INFO

@@ -0,0 +1,224 @@
+Metadata-Version: 2.4
+Name: kingdee-k3cloud-mcp
+Version: 0.1.0
+Summary: MCP Server for Kingdee K3Cloud ERP — connect AI assistants to 金蝶云星空 via natural language
+Project-URL: Homepage, https://github.com/adamzhang1987/kingdee-k3cloud-mcp
+Project-URL: Repository, https://github.com/adamzhang1987/kingdee-k3cloud-mcp
+Project-URL: Issues, https://github.com/adamzhang1987/kingdee-k3cloud-mcp/issues
+Author-email: Adam Zhang <adamzhang1987@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: agent,ai,erp,k3cloud,kingdee,llm,mcp
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: kingdee-cdp-webapi-sdk<9.0.0,>=8.2.0
+Requires-Dist: mcp<2,>=1.26.0
+Requires-Dist: python-dotenv<2,>=1.2.1
+Description-Content-Type: text/markdown
+
+# Kingdee K3Cloud MCP
+
+[![PyPI version](https://img.shields.io/pypi/v/kingdee-k3cloud-mcp)](https://pypi.org/project/kingdee-k3cloud-mcp/)
+[![Python](https://img.shields.io/pypi/pyversions/kingdee-k3cloud-mcp)](https://pypi.org/project/kingdee-k3cloud-mcp/)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![CI](https://github.com/adamzhang1987/kingdee-k3cloud-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/adamzhang1987/kingdee-k3cloud-mcp/actions/workflows/ci.yml)
+
+金蝶云星空 K3Cloud MCP Server，让 AI 助手（Claude Desktop、Claude Code、Cursor、Cline、Cherry Studio、Openclaw 等任意支持 MCP 协议的客户端）通过自然语言查询和操作金蝶 ERP 系统。
+
+> **提示**：Claude Code 用户可配合 [kingdee-k3cloud-skill](https://github.com/adamzhang1987/kingdee-k3cloud-skill) 获得更佳体验。Skill 为 Claude Code 注入金蝶表单字段、常用查询模式和工作流知识，大幅减少试错次数。
+
+MCP Server for Kingdee K3Cloud ERP. Connect AI assistants to your ERP system via the [Model Context Protocol](https://modelcontextprotocol.io/).
+
+## 功能特性
+
+- **11 个 MCP 工具**：覆盖查询、新增、提交、审核、反审核、删除、下推等核心操作
+- **通用接口设计**：单一 `form_id` 参数支持物料、客户、销售订单、采购订单等所有表单，无需为每种业务单独配置
+- **只读/读写模式**：可限制 AI 只能查询，防止误操作
+- **自动会话恢复**：长时间运行时自动处理会话超时，无需人工干预
+- **多传输协议**：支持 stdio（本地）、SSE、streamable-http（远程共享）
+
+## 快速开始
+
+### 方式一：uvx 直接运行（推荐）
+
+无需克隆仓库，直接通过 uvx 运行：
+
+```bash
+# 确保已安装 uv: https://docs.astral.sh/uv/
+uvx kingdee-k3cloud-mcp
+```
+
+### 方式二：从源码运行
+
+```bash
+git clone https://github.com/adamzhang1987/kingdee-k3cloud-mcp.git
+cd kingdee-k3cloud-mcp
+uv sync
+uv run kingdee-k3cloud-mcp
+```
+
+## 配置
+
+复制环境变量模板并填写：
+
+```bash
+cp .env.example .env
+```
+
+| 环境变量 | 说明 | 示例 |
+|----------|------|------|
+| `KD_SERVER_URL` | 金蝶服务器地址（必须以 `/k3cloud/` 结尾） | `https://your-server/k3cloud/` |
+| `KD_ACCT_ID` | 账套 ID | `your_acct_id` |
+| `KD_USERNAME` | 用户名 | `your_username` |
+| `KD_APP_ID` | 第三方应用 ID | `your_app_id` |
+| `KD_APP_SEC` | 第三方应用密钥 | `your_app_secret` |
+| `KD_LCID` | 语言（默认 2052 中文） | `2052` |
+| `KD_ORG_NUM` | 组织编码（可选） | |
+
+> 第三方应用 ID 和密钥需在金蝶云星空管理端的「第三方系统登录授权」中申请。
+
+## 客户端配置
+
+### Claude Desktop
+
+编辑 `~/Library/Application Support/Claude/claude_desktop_config.json`（macOS）：
+
+```json
+{
+  "mcpServers": {
+    "kingdee-k3cloud": {
+      "command": "uvx",
+      "args": ["kingdee-k3cloud-mcp"],
+      "env": {
+        "KD_SERVER_URL": "https://your-server/k3cloud/",
+        "KD_ACCT_ID": "your_acct_id",
+        "KD_USERNAME": "your_username",
+        "KD_APP_ID": "your_app_id",
+        "KD_APP_SEC": "your_app_secret",
+        "KD_LCID": "2052"
+      }
+    }
+  }
+}
+```
+
+### Claude Code
+
+在项目目录下创建 `.mcp.json`：
+
+```json
+{
+  "mcpServers": {
+    "kingdee-k3cloud": {
+      "command": "uvx",
+      "args": ["kingdee-k3cloud-mcp"],
+      "env": {
+        "KD_SERVER_URL": "https://your-server/k3cloud/",
+        "KD_ACCT_ID": "your_acct_id",
+        "KD_USERNAME": "your_username",
+        "KD_APP_ID": "your_app_id",
+        "KD_APP_SEC": "your_app_secret",
+        "KD_LCID": "2052"
+      }
+    }
+  }
+}
+```
+
+### Cursor / Windsurf 及其他 MCP 客户端
+
+配置方式与 Claude Desktop 类似，参考各客户端的 MCP 配置文档，使用相同的 `uvx` 命令和环境变量。
+
+### SSE 模式（远程共享）
+
+如需多人共用同一个服务实例：
+
+```bash
+# 启动 SSE 服务（默认端口 8000）
+FASTMCP_HOST=0.0.0.0 FASTMCP_PORT=8080 uvx kingdee-k3cloud-mcp --transport sse
+```
+
+客户端连接地址：`http://your-server:8080/sse`
+
+可通过 `MCP_API_KEY` 环境变量启用 Bearer Token 鉴权。
+
+## 可用工具
+
+| 工具 | 类型 | 说明 |
+|------|------|------|
+| `query_bill` | 查询 | 查询单据数据（返回二维数组） |
+| `query_bill_json` | 查询 | 查询单据数据（返回 JSON，字段名作为 key） |
+| `view_bill` | 查询 | 查看单条记录完整详情 |
+| `query_metadata` | 查询 | 查询表单字段结构（元数据） |
+| `save_bill` | 写入 | 保存/新增单据 |
+| `submit_bill` | 写入 | 提交单据 |
+| `audit_bill` | 写入 | 审核单据 |
+| `unaudit_bill` | 写入 | 反审核单据 |
+| `delete_bill` | 写入 | 删除单据 |
+| `execute_operation` | 写入 | 执行自定义操作（禁用、反禁用等） |
+| `push_bill` | 写入 | 下推单据（如销售订单→发货通知单） |
+
+所有工具通过 `form_id` 参数支持任意表单（物料、客户、供应商、销售订单、采购订单等）。
+
+## 只读模式
+
+通过 `--mode readonly` 或 `MCP_MODE=readonly` 限制服务器只暴露 4 个查询工具，防止 AI 误操作写入数据。
+
+```json
+"args": ["kingdee-k3cloud-mcp", "--mode", "readonly"]
+```
+
+或：
+
+```json
+"env": {
+  "MCP_MODE": "readonly",
+  ...
+}
+```
+
+## 调试
+
+使用 MCP Inspector 可视化调试工具：
+
+```bash
+uvx mcp dev src/kingdee_k3cloud_mcp/server.py
+```
+
+## 架构说明
+
+```
+AI 助手（Claude Desktop / Claude Code / Cursor / Cline / Openclaw 等）
+        │  MCP 协议
+        ▼
+kingdee-k3cloud-mcp（本项目）
+        │  Kingdee Web API SDK
+        ▼
+金蝶云星空 K3Cloud
+```
+
+本项目使用官方金蝶 Python SDK（[kingdee-cdp-webapi-sdk](https://pypi.org/project/kingdee-cdp-webapi-sdk/)）与 K3Cloud API 通信，并通过 [FastMCP](https://github.com/modelcontextprotocol/python-sdk) 将其封装为标准 MCP 工具。
+
+## 配套 Skill（Claude Code 用户）
+
+[kingdee-k3cloud-skill](https://github.com/adamzhang1987/kingdee-k3cloud-skill) 是面向 Claude Code 的配套 Skill，提供：
+
+- 常用表单 ID 速查表（BD_MATERIAL、SAL_SaleOrder 等）
+- 已验证字段名列表（避免字段名错误导致 500）
+- 日报、客户查询、销售分析、库存分析、订单追踪等完整工作流
+
+安装后 Claude Code 可自动掌握金蝶 ERP 的正确查询方式，无需反复试错。
+
+## 许可证
+
+Apache License 2.0 — 详见 [LICENSE](LICENSE)