@vennyx/solicrm-mcp 0.1.0

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.
Files changed (6) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +100 -0
  3. package/dist/bin.js +4097 -0
  4. package/dist/index.d.ts +399 -0
  5. package/dist/index.js +4140 -0
  6. package/package.json +57 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Vennyx A.Ş.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,100 @@
1
+ # @vennyx/solicrm-mcp
2
+
3
+ [MCP](https://modelcontextprotocol.io) server for [SoliCRM](https://solicrm.com) — exposes
4
+ contacts, companies, deals, pipelines, activities, tasks, notes, saved views and
5
+ cross-resource search as tools an AI agent can call.
6
+
7
+ Every tool is a thin wrapper around the typed [`@vennyx/solicrm`](https://www.npmjs.com/package/@vennyx/solicrm)
8
+ SDK, and its input schema **is** the zod schema the SoliCRM API validates against — the
9
+ tool surface cannot drift from the API.
10
+
11
+ ## Install
12
+
13
+ No install needed — run it with `npx`:
14
+
15
+ ```sh
16
+ SOLICRM_API_KEY=scrm_… SOLICRM_TENANT_ID=… npx @vennyx/solicrm-mcp
17
+ ```
18
+
19
+ Requires Node.js ≥ 18 (or Bun). ESM only.
20
+
21
+ ## Claude Code / Claude Desktop
22
+
23
+ ```json
24
+ {
25
+ "mcpServers": {
26
+ "solicrm": {
27
+ "command": "npx",
28
+ "args": ["-y", "@vennyx/solicrm-mcp"],
29
+ "env": {
30
+ "SOLICRM_API_KEY": "scrm_…",
31
+ "SOLICRM_TENANT_ID": "00000000-0000-0000-0000-000000000000"
32
+ }
33
+ }
34
+ }
35
+ }
36
+ ```
37
+
38
+ ## Environment variables
39
+
40
+ | Variable | Required | Meaning |
41
+ | --- | --- | --- |
42
+ | `SOLICRM_API_KEY` | yes | Tenant API key, starts with `scrm_`. Create it under **Dashboard → API keys**. |
43
+ | `SOLICRM_TENANT_ID` | yes | UUID of the tenant the key belongs to. |
44
+ | `SOLICRM_BASE_URL` | no | API base; defaults to `https://api.solicrm.com`. |
45
+ | `SOLICRM_SCOPE` | no | `read` \| `write` \| `admin`. Filters `tools/list` only — see “Scopes” below. Defaults to `admin`. |
46
+
47
+ A missing or empty `SOLICRM_API_KEY`/`SOLICRM_TENANT_ID` is a **hard startup error** (in
48
+ Turkish, matching the rest of the product) — the process never starts up silently
49
+ half-configured.
50
+
51
+ ## Transports
52
+
53
+ ```sh
54
+ solicrm-mcp # stdio (default)
55
+ solicrm-mcp --http # standalone Streamable HTTP on 127.0.0.1:3737, POST /mcp
56
+ solicrm-mcp --http 8080 # …on a custom port
57
+ solicrm-mcp --help
58
+ solicrm-mcp --version
59
+ ```
60
+
61
+ The HTTP mode is stateless (a fresh server per request), binds to loopback by default and
62
+ answers anything other than `POST /mcp` with an error — it is a self-host convenience, not
63
+ a public endpoint. SoliCRM also hosts the same server at `POST /mcp` on its own API, so most
64
+ users never need this flag.
65
+
66
+ ## Tools
67
+
68
+ 22 tools: `list_contacts`, `get_contact`, `create_contact`, `update_contact`,
69
+ `list_companies`, `get_company`, `create_company`, `update_company`, `list_deals`,
70
+ `get_deal`, `create_deal`, `update_deal`, `move_deal_stage`, `list_pipelines`,
71
+ `list_activities`, `create_activity`, `list_tasks`, `create_task`, `complete_task`,
72
+ `create_note`, `search`, `list_saved_views`.
73
+
74
+ Two resources (`solicrm://contacts/{id}`, `solicrm://deals/{id}`) and one prompt
75
+ (`summarize_pipeline`).
76
+
77
+ ## Tenant isolation and scopes
78
+
79
+ - **No tool takes a `tenantId` argument** and **no resource URI carries a tenant segment.**
80
+ The tenant always comes from the API key, so “reach into another tenant” is not a check
81
+ that can fail — it is structurally impossible.
82
+ - `SOLICRM_SCOPE` only decides which tools are *advertised*. The real authorization is
83
+ recomputed by the SoliCRM API on **every single request** from the key's scope
84
+ intersected with the current role ceiling of the key's owner. Demoting the owner takes
85
+ effect immediately, even for an already-running server process.
86
+
87
+ ## Errors
88
+
89
+ Tool failures come back as `isError: true` with the server's message verbatim (Turkish).
90
+ Unexpected internal failures are reduced to a single generic message — raw upstream text is
91
+ never forwarded to the agent.
92
+
93
+ ## Related
94
+
95
+ - [`@vennyx/solicrm`](https://www.npmjs.com/package/@vennyx/solicrm) — the typed SDK these
96
+ tools are built on.
97
+
98
+ ## License
99
+
100
+ MIT © Vennyx A.Ş.