Metadata-Version: 2.4
Name: k3cloud-query-mcp
Version: 1.0.0
Summary: Nxr K3Cloud Query MCP Server — 金蝶云星空纯查询 MCP 服务，仅提供只读查询工具
Project-URL: Homepage, https://github.com/nxr/k3cloud-query-mcp
Project-URL: Repository, https://github.com/nxr/k3cloud-query-mcp
Author: Nxr Team
License: Apache-2.0
License-File: LICENSE
Keywords: erp,k3cloud,kingdee,mcp,mcp-server,nxr,query,金蝶
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

# k3cloud-query-mcp

金蝶云星空 K3Cloud MCP 查询服务（纯查询版）—— 让 AI 助手通过自然语言查询金蝶 ERP 数据。

## 特性

| 特性 | k3cloud-query-mcp |
|------|----------------------|
| 查询工具 |  ✅ 8 个 |
| 写入/操作工具 | ❌ 已移除 |
| 适用场景 | 纯查询 |

## 查询工具列表

| 工具 | 说明 |
|------|------|
| `query_bill` | 查询单据数据（二维数组） |
| `query_bill_json` | 查询单据数据（JSON 对象数组） |
| `count_bill` | 估算查询条件下的数据行数 |
| `query_bill_all` | 自动翻页查询（≤ 数千行） |
| `query_bill_to_file` | 大数据量流式导出到文件 |
| `query_bill_range` | 按日期分片查询（跨月/跨年） |
| `view_bill` | 查看单条记录完整详情 |
| `query_metadata` | 查询表单字段元数据 |

## 安装

```bash
pip install k3cloud-query-mcp
```

或使用 uv：

```bash
uv add k3cloud-query-mcp
```

## 配置

在项目根目录创建 `.env` 文件：

```env
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
```

## 使用

### Claude Desktop 配置

```json
{
  "mcpServers": {
    "k3cloud-query": {
      "command": "uvx",
      "args": ["k3cloud-query-mcp"],
      "env": {
        "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/"
      }
    }
  }
}
```

### SSE 模式

```bash
k3cloud-query-mcp --transport sse
```

### 开发

```bash
# 安装依赖
uv sync

# 运行
uv run k3cloud-query-mcp

# 测试
make test

# 代码检查
make lint

# 格式化
make format
```
