@jclvsh/iris 0.23.2 → 0.25.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.
- package/README.md +31 -0
- package/dist/cli.js +4 -0
- package/dist/commands/affiliate.d.ts +3 -0
- package/dist/commands/affiliate.js +15 -0
- package/dist/commands/recap.d.ts +3 -0
- package/dist/commands/recap.js +15 -0
- package/dist/server.js +4 -0
- package/dist/tool-policy.d.ts +2 -2
- package/dist/tool-policy.js +6 -0
- package/dist/tools/affiliate.d.ts +3 -0
- package/dist/tools/affiliate.js +12 -0
- package/dist/tools/recap.d.ts +3 -0
- package/dist/tools/recap.js +12 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -76,6 +76,8 @@ iris campaigns --help
|
|
|
76
76
|
| billing | `b` | plans | 1 |
|
|
77
77
|
| channels | `ch` | accounts, availability, send | 3 |
|
|
78
78
|
| credits | `cr` | balance, buy | 2 |
|
|
79
|
+
| affiliate | — | (status, link, sign-ups, and commission totals) | 1 |
|
|
80
|
+
| recap | — | (your last 30 days of outreach as counts) | 1 |
|
|
79
81
|
| responder | `r` | status, configure, activity, show, pause, resume, triggers list, triggers add, triggers update, triggers remove, triggers posts | 11 |
|
|
80
82
|
|
|
81
83
|
## MCP Server Configuration
|
|
@@ -127,6 +129,19 @@ Add to `.cursor/mcp.json`:
|
|
|
127
129
|
}
|
|
128
130
|
```
|
|
129
131
|
|
|
132
|
+
## Hosted Endpoint
|
|
133
|
+
|
|
134
|
+
Clients that connect to a remote MCP server can use the hosted endpoint instead of this package:
|
|
135
|
+
|
|
136
|
+
```
|
|
137
|
+
https://api.iris-ai.dev/mcp
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
- Transport: MCP streamable HTTP, `POST` only.
|
|
141
|
+
- Registry: listed in the [official MCP registry](https://registry.modelcontextprotocol.io) as `io.github.JCLVSH/iris`.
|
|
142
|
+
- Auth: `Authorization: Bearer is_live_...` (the same API key; its scopes apply). `initialize` and `tools/list` answer without a key, so a client can read the tool list before signing up; calling a tool needs the key.
|
|
143
|
+
- Tools: a subset of this package. Credits, API key, webhook, affiliate, and recap tools are only available through the npm package. The class of each hosted tool is listed at https://www.iris-ai.dev/docs#mcp-hosted.
|
|
144
|
+
|
|
130
145
|
## Available Tools
|
|
131
146
|
|
|
132
147
|
### Campaigns
|
|
@@ -298,6 +313,22 @@ Add to `.cursor/mcp.json`:
|
|
|
298
313
|
| ------------------- | --------------------------------- |
|
|
299
314
|
| `get_billing_plans` | List available subscription plans |
|
|
300
315
|
|
|
316
|
+
### Affiliate
|
|
317
|
+
|
|
318
|
+
| Tool | Description |
|
|
319
|
+
| --------------- | ---------------------------------------------------------------------------------------- |
|
|
320
|
+
| `get_affiliate` | Your affiliate status, link, sign-ups, and commission totals, with the terms (stdio only) |
|
|
321
|
+
|
|
322
|
+
CLI: `iris affiliate`.
|
|
323
|
+
|
|
324
|
+
### Recap
|
|
325
|
+
|
|
326
|
+
| Tool | Description |
|
|
327
|
+
| ----------- | ------------------------------------------------------------------------------------------------------------ |
|
|
328
|
+
| `get_recap` | Your last 30 days of outreach as counts: sent, conversations, replies, and messages per channel (stdio only) |
|
|
329
|
+
|
|
330
|
+
CLI: `iris recap`.
|
|
331
|
+
|
|
301
332
|
### API Keys
|
|
302
333
|
|
|
303
334
|
| Tool | Description |
|
package/dist/cli.js
CHANGED
|
@@ -18,6 +18,8 @@ import { registerBillingCommands } from "./commands/billing.js";
|
|
|
18
18
|
import { registerChannelCommands } from "./commands/channels.js";
|
|
19
19
|
import { registerCreditCommands } from "./commands/credits.js";
|
|
20
20
|
import { registerResponderCommands } from "./commands/responder.js";
|
|
21
|
+
import { registerAffiliateCommands } from "./commands/affiliate.js";
|
|
22
|
+
import { registerRecapCommands } from "./commands/recap.js";
|
|
21
23
|
const program = new Command()
|
|
22
24
|
.name("iris")
|
|
23
25
|
.description("iris CLI - manage campaigns, contacts, messages, and outreach")
|
|
@@ -52,6 +54,8 @@ try {
|
|
|
52
54
|
registerChannelCommands(program, client);
|
|
53
55
|
registerCreditCommands(program, client);
|
|
54
56
|
registerResponderCommands(program, client);
|
|
57
|
+
registerAffiliateCommands(program, client);
|
|
58
|
+
registerRecapCommands(program, client);
|
|
55
59
|
await program.parseAsync(process.argv);
|
|
56
60
|
}
|
|
57
61
|
catch (error) {
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { formatOutput, handleError, getFormat } from "../cli-utils.js";
|
|
2
|
+
export function registerAffiliateCommands(program, client) {
|
|
3
|
+
program
|
|
4
|
+
.command("affiliate")
|
|
5
|
+
.description("your affiliate status, link, sign-ups, and commission totals")
|
|
6
|
+
.action(async () => {
|
|
7
|
+
try {
|
|
8
|
+
const result = await client.get("/affiliate");
|
|
9
|
+
formatOutput(result, getFormat(program.opts()));
|
|
10
|
+
}
|
|
11
|
+
catch (error) {
|
|
12
|
+
handleError(error);
|
|
13
|
+
}
|
|
14
|
+
});
|
|
15
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { formatOutput, handleError, getFormat } from "../cli-utils.js";
|
|
2
|
+
export function registerRecapCommands(program, client) {
|
|
3
|
+
program
|
|
4
|
+
.command("recap")
|
|
5
|
+
.description("your last 30 days of outreach: messages sent, conversations, replies, and messages per channel")
|
|
6
|
+
.action(async () => {
|
|
7
|
+
try {
|
|
8
|
+
const result = await client.get("/recap");
|
|
9
|
+
formatOutput(result, getFormat(program.opts()));
|
|
10
|
+
}
|
|
11
|
+
catch (error) {
|
|
12
|
+
handleError(error);
|
|
13
|
+
}
|
|
14
|
+
});
|
|
15
|
+
}
|
package/dist/server.js
CHANGED
|
@@ -18,6 +18,8 @@ import { registerUsageTools } from "./tools/usage.js";
|
|
|
18
18
|
import { registerAutopilotTools } from "./tools/autopilot.js";
|
|
19
19
|
import { registerResponderTools } from "./tools/responder.js";
|
|
20
20
|
import { registerAudienceTools } from "./tools/audiences.js";
|
|
21
|
+
import { registerAffiliateTools } from "./tools/affiliate.js";
|
|
22
|
+
import { registerRecapTools } from "./tools/recap.js";
|
|
21
23
|
export function createIrisServer({ client, version, profile }) {
|
|
22
24
|
const server = new McpServer({ name: "iris", version });
|
|
23
25
|
const registrar = createPolicyRegistrar(server, TOOL_POLICY, profile);
|
|
@@ -36,6 +38,8 @@ export function createIrisServer({ client, version, profile }) {
|
|
|
36
38
|
registerAgentCreditTools(registrar, client);
|
|
37
39
|
registerUsageTools(registrar, client);
|
|
38
40
|
registerAutopilotTools(registrar, client);
|
|
41
|
+
registerAffiliateTools(registrar, client);
|
|
42
|
+
registerRecapTools(registrar, client);
|
|
39
43
|
registerResponderTools(registrar, client);
|
|
40
44
|
registerAudienceTools(registrar, client);
|
|
41
45
|
return server;
|
package/dist/tool-policy.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { type PolicyTable, type ToolClass, type ToolPolicy, type ToolProfile } from "./policy.js";
|
|
2
2
|
export type { ToolClass, ToolPolicy, ToolProfile };
|
|
3
|
-
export declare const TOOL_CATEGORIES: readonly ["campaigns", "contacts", "conversations", "messages", "channels", "discovery", "audiences", "autopilot", "responder", "ai", "analytics", "notifications", "usage", "billing", "credits", "API keys", "webhooks"];
|
|
3
|
+
export declare const TOOL_CATEGORIES: readonly ["campaigns", "contacts", "conversations", "messages", "channels", "discovery", "audiences", "autopilot", "responder", "ai", "analytics", "notifications", "usage", "billing", "credits", "affiliate", "recap", "API keys", "webhooks"];
|
|
4
4
|
export type ToolCategory = (typeof TOOL_CATEGORIES)[number];
|
|
5
5
|
export declare const TOOL_POLICY: PolicyTable<ToolCategory>;
|
|
6
|
-
export declare const toolPolicy: (name: string) => ToolPolicy<"campaigns" | "contacts" | "usage" | "messages" | "conversations" | "discovery" | "ai" | "webhooks" | "notifications" | "analytics" | "billing" | "channels" | "credits" | "responder" | "audiences" | "autopilot" | "API keys">;
|
|
6
|
+
export declare const toolPolicy: (name: string) => ToolPolicy<"campaigns" | "contacts" | "usage" | "messages" | "conversations" | "discovery" | "ai" | "webhooks" | "notifications" | "analytics" | "billing" | "channels" | "credits" | "responder" | "affiliate" | "recap" | "audiences" | "autopilot" | "API keys">;
|
|
7
7
|
export declare const isToolEnabled: (name: string, profile: ToolProfile) => boolean;
|
|
8
8
|
export declare const toolAnnotations: (name: string) => {
|
|
9
9
|
readOnlyHint: boolean;
|
package/dist/tool-policy.js
CHANGED
|
@@ -15,6 +15,8 @@ export const TOOL_CATEGORIES = [
|
|
|
15
15
|
"usage",
|
|
16
16
|
"billing",
|
|
17
17
|
"credits",
|
|
18
|
+
"affiliate",
|
|
19
|
+
"recap",
|
|
18
20
|
"API keys",
|
|
19
21
|
"webhooks",
|
|
20
22
|
];
|
|
@@ -126,6 +128,10 @@ export const TOOL_POLICY = {
|
|
|
126
128
|
get_usage: hosted("usage", "read"),
|
|
127
129
|
get_changelog: hosted("usage", "read"),
|
|
128
130
|
get_billing_plans: hosted("billing", "read"),
|
|
131
|
+
// affiliate program (hosted tool set is frozen: npm package only)
|
|
132
|
+
get_affiliate: localOnly("affiliate", "read"),
|
|
133
|
+
// recap (hosted tool set is frozen: npm package only)
|
|
134
|
+
get_recap: localOnly("recap", "read"),
|
|
129
135
|
// credits (agent payments: never hosted)
|
|
130
136
|
get_credit_balance: localOnly("credits", "read"),
|
|
131
137
|
purchase_credit_pack: localOnly("credits", "sensitive"),
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { formatMcpError } from "../cli-utils.js";
|
|
2
|
+
export function registerAffiliateTools(server, client) {
|
|
3
|
+
server.tool("get_affiliate", 'the user\'s affiliate status ("none" if they have not applied), code and link, sign-up count, commission totals in US cents (in the hold, payable, paid out), and the program terms. read-only; applying is done in the app at /settings/affiliate. requires read scope.', {}, async () => {
|
|
4
|
+
try {
|
|
5
|
+
const result = await client.get("/affiliate");
|
|
6
|
+
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
7
|
+
}
|
|
8
|
+
catch (error) {
|
|
9
|
+
return formatMcpError(error);
|
|
10
|
+
}
|
|
11
|
+
});
|
|
12
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { formatMcpError } from "../cli-utils.js";
|
|
2
|
+
export function registerRecapTools(server, client) {
|
|
3
|
+
server.tool("get_recap", "the user's last 30 days of outreach as counts: messages sent, conversations (one contact in one campaign), how many wrote back, the reply rate as a whole percent, and messages sent per channel. the responder's automatic replies and comment-trigger DMs are left out. counts only: no names or message text. read-only; a public share link is created in the app at /recap. requires read scope.", {}, async () => {
|
|
4
|
+
try {
|
|
5
|
+
const result = await client.get("/recap");
|
|
6
|
+
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
7
|
+
}
|
|
8
|
+
catch (error) {
|
|
9
|
+
return formatMcpError(error);
|
|
10
|
+
}
|
|
11
|
+
});
|
|
12
|
+
}
|