ivy-sale-cli
ivy-sale-agent 平台开放接口的 CLI + MCP Server 客户端。同一个包,两种用法:
- CLI:直接在终端里用
ivy-sale <command>。 - MCP Server:
ivy-sale mcp serve以 stdio 方式启动,配置进 Claude Code / Codex 等支持 MCP 的 AI Agent 客户端里,让它调用平台的客户/待办/知识库/问答能力。
两者背后走同一套 /open/v1/* 网关接口、同一份凭证。
安装
发布到 PyPI 后(见文末「发布」),终端用户直接:
uv pip install ivy-sale-cli
# 或不装到全局环境、临时跑一次:
uvx ivy-sale-cli --help
开发这个仓库本身则用可编辑安装:
pip install -e .
Windows 终端如果看到中文输出乱码(不影响 MCP 客户端使用,只影响人眼直接看终端), 设置
set PYTHONUTF8=1或chcp 65001后再运行即可。
登录
Phase 1 暂不支持浏览器登录,需要先拿到一个开放平台 Token(sk- 开头),然后:
ivy-sale auth login --api-key sk-xxxxxxxx
ivy-sale auth whoami
也可以不落盘,直接用环境变量(适合 CI / 被其他 Agent 当子进程拉起的场景):
export SALE_AGENT_API_KEY=sk-xxxxxxxx
export SALE_AGENT_BASE_URL=https://api.ivy.sale/open/v1 # 默认值,按需覆盖
CLI 用法
ivy-sale customer list --keyword 张三
ivy-sale customer get 123
ivy-sale customer create --name "某某公司" --phone 138xxxx
ivy-sale todo list --pending
ivy-sale todo add "跟进某某客户" --due "2026-09-05 18:00:00"
ivy-sale todo done 456
ivy-sale knowledge search "退保流程"
所有命令都支持 --json 输出机器可读结构,供脚本/其他 Agent 解析。
作为 MCP Server 使用
{
"mcpServers": {
"ivy-sale": {
"command": "ivy-sale",
"args": ["mcp", "serve"],
"env": {
"SALE_AGENT_API_KEY": "sk-xxxxxxxx",
"SALE_AGENT_BASE_URL": "https://api.ivy.sale/open/v1"
}
}
}
}
启动时会先用 Token 调用一次 /open/v1/me/info 自检,Token 无效会直接报错退出,不会注册工具。
Phase 1 固定注册 7 个工具(search_customers / get_customer / create_customer / list_todos /
create_todo / complete_todo / search_knowledge),不按 Token 的 scope 动态过滤——
如果 Token 缺少对应权限,调用对应工具时网关会返回 403,工具的返回文本里会带上缺失的 scope 名。
发布(维护者)
python -m pip install --upgrade build twine
python -m build # 产出 dist/*.whl + dist/*.tar.gz
python -m twine check dist/* # 校验元数据/README能否被PyPI正常渲染
python -m twine upload dist/* # 需要 PyPI 账号 + API token(https://pypi.org/manage/account/token/)
发新版本前记得改 pyproject.toml 里的 version(PyPI 不允许覆盖已发布过的版本号)。
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ivy_sale_cli-0.1.2.tar.gz.
File metadata
- Download URL: ivy_sale_cli-0.1.2.tar.gz
- Upload date:
- Size: 8.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3b914af270620ccc33ec468aded36b730d3595645803617a1771e3597ad86250
|
|
| MD5 |
ff809c8db98e4629468152bf39bc82bc
|
|
| BLAKE2b-256 |
f4b494626f54be3febd5996c84d6670bd9ec00e0776618dc88c96c0427992ad1
|
File details
Details for the file ivy_sale_cli-0.1.2-py3-none-any.whl.
File metadata
- Download URL: ivy_sale_cli-0.1.2-py3-none-any.whl
- Upload date:
- Size: 11.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7b59e20e012e7de5892f4f8ceb061891a085bcba51c86d8f7d74388100ab3289
|
|
| MD5 |
ca4d633a419c3b52ea0850771e5b9762
|
|
| BLAKE2b-256 |
fa6b39cc1ce8d3e1d83ed19a24f5e843dea31e2ffa4848967bf431c6d0bc0a39
|