patchxnote-agent 0.2.11 → 0.2.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -6,10 +6,12 @@ This npm package is the installer and thin launcher wrapper for PatchXNote Agent
|
|
|
6
6
|
|
|
7
7
|
PatchXNote Agent is the local AI assistant connector for PatchXNote. It lets an MCP-capable AI assistant find PatchXNote records, inspect AI-generated results, create Markdown drafts, and manually send user-approved messages to Feishu, DingTalk, or another webhook.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Version `0.2.12` defaults to the production API at `https://freenote.patch-x.cn`. When upgrading from test, update or remove explicit server-address overrides in your CLI and MCP host configuration, then run `mcp login` in the same runtime and profile that launches MCP. Test credentials and records do not migrate to production.
|
|
10
|
+
|
|
11
|
+
Give this one-line prompt to an AI assistant:
|
|
10
12
|
|
|
11
13
|
```text
|
|
12
|
-
Help me connect PatchXNote MCP and install the PatchXNote MCP Skill when the client supports Agent Skills. First, if this is a local command-capable environment,
|
|
14
|
+
Help me connect PatchXNote MCP and install the PatchXNote MCP Skill when the client supports Agent Skills. First, if this is a local command-capable environment, run npx -y patchxnote-agent@latest skill install on this machine so future or long sessions remember the PatchXNote SOP; if the current client does not support Skill installation, do not treat that as a connection blocker and continue with MCP setup according to the client's capabilities. Identify the MCP client you are running in: if this is a local MCP client such as Codex, Cursor, VS Code, Claude Desktop, Claude Code, or Windsurf, run npx -y patchxnote-agent@latest setup --client <client-id> on this machine in the same OS/runtime that will later launch the MCP server. If this is an AI client or cloud platform that cannot run local commands but supports Remote MCP, custom connectors, custom MCP services, or tool plugins, create a custom MCP connector named PatchXNote MCP and connect it with this PatchXNote Remote MCP URL: https://freenote.patch-x.cn/mcp. If you are not sure which client ID or config format to use, local clients should first run npx -y patchxnote-agent@latest mcp config and use the printed generic stdio config, while remote clients should look for a Remote MCP Server URL, MCP Server URL, or Custom Connector setup entry. For login, open the browser and let me complete PatchXNote phone-code authorization there; do not ask me to paste OTP codes, OAuth codes, authorization codes, access tokens, refresh tokens, or webhook secrets into chat. After setup, call patchxnote_get_current_user and patchxnote_list_memories with {"platform":"mobile","limit":5} to verify it works. References: https://github.com/ZsTs119/patchxnote-agent and https://patchx2025.feishu.cn/wiki/PnVRwYT7IirFPckairGcWPnHnCd
|
|
13
15
|
```
|
|
14
16
|
|
|
15
17
|
The npm package includes an Agent Skills package at `skills/patchxnote-mcp/`. Compatible agents can install or refresh it with:
|
|
@@ -18,7 +20,9 @@ The npm package includes an Agent Skills package at `skills/patchxnote-mcp/`. Co
|
|
|
18
20
|
npx -y patchxnote-agent@latest skill install
|
|
19
21
|
```
|
|
20
22
|
|
|
21
|
-
The skill teaches the AI the PatchXNote SOP. MCP setup and browser login still use the commands below.
|
|
23
|
+
The skill teaches the AI the PatchXNote SOP. MCP setup and browser login still use the commands below. By default, the installer writes under the user's home directory at `.agents/skills/patchxnote-mcp`; use `--agent <id>` only after that client's local skills directory is verified.
|
|
24
|
+
|
|
25
|
+
Useful skill installer options are `--dry-run --json`, `--home <path>` or `PATCHXNOTE_AGENT_SKILL_HOME=<path>`, `--agent universal|codex|cursor|claude-code|gemini-cli|github-copilot|all`, and `--force`. Existing unmanaged or manually edited `patchxnote-mcp` folders are protected unless `--force` is supplied.
|
|
22
26
|
|
|
23
27
|
Run setup for a supported local client:
|
|
24
28
|
|
|
@@ -35,7 +39,7 @@ PatchXNote Agent currently exposes two login surfaces and two MCP service shapes
|
|
|
35
39
|
| Browser MCP login | `npx -y patchxnote-agent@latest mcp login` | Recommended for desktop editors and local MCP hosts. |
|
|
36
40
|
| Terminal CLI login | `npx -y patchxnote-agent@latest login` | Terminal-only users, headless runtimes, or the legacy local Agent path. |
|
|
37
41
|
| Local MCP service | `npx -y patchxnote-agent@latest mcp serve` | VS Code, Cursor, Codex, Claude Desktop, Windsurf, Trae, Qoder, WorkBuddy, and other stdio MCP clients. |
|
|
38
|
-
| Hosted remote MCP gateway | `https://
|
|
42
|
+
| Hosted remote MCP gateway | `https://freenote.patch-x.cn/mcp` | Feishu Aily, Doubao Work Partner, Tencent Agent Development Platform, enterprise WorkBuddy, and other platform clients that cannot run local commands. |
|
|
39
43
|
|
|
40
44
|
Log in with browser OAuth, then check or clear the MCP login state:
|
|
41
45
|
|
|
@@ -77,11 +81,23 @@ npx -y patchxnote-agent@latest install --print-config
|
|
|
77
81
|
|
|
78
82
|
It currently exposes 19 MCP tools grouped around account/record lookup, webhook configuration and sending, and explicit AI result inspection.
|
|
79
83
|
|
|
84
|
+
Common npm wrapper commands:
|
|
85
|
+
|
|
86
|
+
```sh
|
|
87
|
+
npx -y patchxnote-agent@latest skill install
|
|
88
|
+
npx -y patchxnote-agent@latest setup --client cursor
|
|
89
|
+
npx -y patchxnote-agent@latest mcp login
|
|
90
|
+
npx -y patchxnote-agent@latest mcp status
|
|
91
|
+
npx -y patchxnote-agent@latest mcp config
|
|
92
|
+
npx -y patchxnote-agent@latest mcp serve
|
|
93
|
+
npx -y patchxnote-agent@latest install --print-config
|
|
94
|
+
```
|
|
95
|
+
|
|
80
96
|
Common CLI examples:
|
|
81
97
|
|
|
82
98
|
```sh
|
|
83
99
|
patchxnote model-io list --platform mobile
|
|
84
|
-
patchxnote model-io packaged-result --
|
|
100
|
+
patchxnote model-io packaged-result --request-id <request_id> --platform mobile --out ./packaged-result.json
|
|
85
101
|
patchxnote model-io provider-response --request-id <request_id> --platform mobile --out ./provider-response.json
|
|
86
102
|
patchxnote webhook set "Product Feishu" --type feishu --url-stdin
|
|
87
103
|
patchxnote webhook send --target "Product Feishu" --file ./message.md
|
package/package.json
CHANGED
|
@@ -72,6 +72,12 @@ npx -y patchxnote-agent@latest mcp login
|
|
|
72
72
|
|
|
73
73
|
The user completes phone verification in the browser page. Do not ask for codes, token-shaped strings, or webhook secrets in chat.
|
|
74
74
|
|
|
75
|
+
## Production Environment
|
|
76
|
+
|
|
77
|
+
Agent `0.2.12` and later default to `https://freenote.patch-x.cn`; hosted clients use `https://freenote.patch-x.cn/mcp`. When upgrading from test, inspect explicit server flags, `PATCHXNOTE_SERVER_BASE_URL` / legacy `PATCHNOTE_SERVER_BASE_URL`, and `server.base_url` in the CLI and MCP host configuration. They override the default.
|
|
78
|
+
|
|
79
|
+
After switching, run browser `mcp login` in the same OS/runtime and profile that launches MCP, then `mcp status --verify`. OAuth credentials match the server address; test login and records do not migrate to production. Use separate profiles with explicit base URLs when retaining both environments.
|
|
80
|
+
|
|
75
81
|
## Verification
|
|
76
82
|
|
|
77
83
|
First verify the local CLI auth state:
|