@drdoc-com/pi-drdoc 1.0.1 → 1.0.3
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 +35 -1
- package/package.json +1 -1
- package/src/index.ts +1 -1
- package/src/tools.ts +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Pi Plugin for Dr.DOC
|
|
1
|
+
# Pi Plugin for Dr.DOC DMS
|
|
2
2
|
|
|
3
3
|
An integration plugin Package for the **Pi Agent** (`pi.dev`) ecosystem to interact seamlessly with the [**Dr.DOC Document Management System** \(DMS/ECM\)](https://drdoc.com/node/de/products/web).
|
|
4
4
|
|
|
@@ -46,6 +46,32 @@ pi install git:https://github.com/drdoc-com/pi-drdoc
|
|
|
46
46
|
|
|
47
47
|
---
|
|
48
48
|
|
|
49
|
+
## Usage
|
|
50
|
+
|
|
51
|
+
### Pi Slash Commands (within Pi Agent)
|
|
52
|
+
|
|
53
|
+
Use Pi Slash Command (within Pi Agent) to signin/login.
|
|
54
|
+
Format:
|
|
55
|
+
```bash
|
|
56
|
+
/drdoc_login <baseUrl> <username> <password> <totp> <ignoreSSL:1,0>
|
|
57
|
+
```
|
|
58
|
+
Example:
|
|
59
|
+
```bash
|
|
60
|
+
/drdoc_login https://drdoc.com demo password "" 1
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
And signout/logout:
|
|
64
|
+
```bash
|
|
65
|
+
/drdoc_logout
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Pi Agent Tool Calling
|
|
69
|
+
|
|
70
|
+
Example:
|
|
71
|
+
```
|
|
72
|
+
Suche im Dr.DOC Archiv "rec" alle Rechnungen von Firma Amazon aus diesem Jahr.
|
|
73
|
+
```
|
|
74
|
+
|
|
49
75
|
## Configuration
|
|
50
76
|
|
|
51
77
|
The plugin utilizes configuration options supplied by the Dr.DOC client or environment variables.
|
|
@@ -62,6 +88,14 @@ The plugin utilizes configuration options supplied by the Dr.DOC client or envir
|
|
|
62
88
|
|
|
63
89
|
---
|
|
64
90
|
|
|
91
|
+
### Security Notes
|
|
92
|
+
* Pi Agent is designed as a **personal** AI agent. Users must operate their own private Pi Agent instance rather than using an instance hosted on the Dr.DOC Web Server.
|
|
93
|
+
* Credential Persistence (/drdoc_login): When using the Dr.DOC AI Chat with Pi configured as the AI endpoint (via `@drdoc-com/pi-openai-api-wrapper`), the `/drdoc_login` command *MUST NOT* be executed. Authentication credentials within the Pi Agent instance are persistent and could potentially be exposed to other users sharing the same instance.
|
|
94
|
+
* Dedicated Service Account: Use a dedicated Dr.DOC user account with limited permissions (e.g. *Datensatzspezifische Berechtigungen*) based on the principle of least privilege (*"need-to-know"*) specifically for AI tasks and the `/drdoc_login` command.
|
|
95
|
+
* Containerized Deployment: Whenever possible, run Pi Agent inside an isolated container environment (e.g., Docker, Podman) to ensure process isolation and security boundaries.
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
65
99
|
## License
|
|
66
100
|
|
|
67
101
|
This project is licensed under the Apache License 2.0.
|
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -27,7 +27,7 @@ export default function (pi: any): void {
|
|
|
27
27
|
baseUrl = process.env.DRDOC_BASE_URL;
|
|
28
28
|
|
|
29
29
|
if (!baseUrl || !username || !password) {
|
|
30
|
-
msgError("Fehler: Syntax ist `/
|
|
30
|
+
msgError("Fehler: Syntax ist `/drdoc_login <baseUrl> <username> <password> <totp> <ignoreSSL:1,0>`");
|
|
31
31
|
return;
|
|
32
32
|
}
|
|
33
33
|
|
package/src/tools.ts
CHANGED
|
@@ -17,7 +17,7 @@ export async function getClient(config: DrDocConfig = {} as DrDocConfig, force:
|
|
|
17
17
|
if (await clientInstance.state())
|
|
18
18
|
msgInfo('getClient: state ok');
|
|
19
19
|
else {
|
|
20
|
-
throw new Error("getClient: DrDocClient ist nicht initialisiert. Bitte vorher den Befehl /
|
|
20
|
+
throw new Error("getClient: DrDocClient ist nicht initialisiert. Bitte vorher den Befehl /drdoc_login ausführen.");
|
|
21
21
|
}
|
|
22
22
|
}
|
|
23
23
|
return clientInstance;
|