@linkedapi/mcp 1.0.1 → 2.0.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 +1 -1
- package/dist/index.js +0 -23
- package/dist/index.js.map +1 -1
- package/dist/linked-api-server.d.ts +3 -3
- package/dist/linked-api-server.d.ts.map +1 -1
- package/dist/linked-api-server.js +37 -55
- package/dist/linked-api-server.js.map +1 -1
- package/dist/linked-api-tools.d.ts +5 -7
- package/dist/linked-api-tools.d.ts.map +1 -1
- package/dist/linked-api-tools.js.map +1 -1
- package/dist/prompts/index.d.ts +2 -2
- package/dist/prompts/index.d.ts.map +1 -1
- package/dist/prompts/index.js +3 -1
- package/dist/prompts/index.js.map +1 -1
- package/dist/tools/get-api-usage-stats.d.ts +0 -2
- package/dist/tools/get-api-usage-stats.d.ts.map +1 -1
- package/dist/tools/get-api-usage-stats.js.map +1 -1
- package/dist/tools/get-conversation.d.ts +4 -7
- package/dist/tools/get-conversation.d.ts.map +1 -1
- package/dist/tools/get-conversation.js +7 -23
- package/dist/tools/get-conversation.js.map +1 -1
- package/dist/tools/get-workflow-result.d.ts +6 -6
- package/dist/tools/get-workflow-result.d.ts.map +1 -1
- package/dist/tools/get-workflow-result.js +37 -13
- package/dist/tools/get-workflow-result.js.map +1 -1
- package/dist/tools/nv-get-conversation.d.ts +4 -7
- package/dist/tools/nv-get-conversation.d.ts.map +1 -1
- package/dist/tools/nv-get-conversation.js +7 -23
- package/dist/tools/nv-get-conversation.js.map +1 -1
- package/dist/types/linked-api-tool-result.type.d.ts +6 -0
- package/dist/types/linked-api-tool-result.type.d.ts.map +1 -0
- package/dist/types/linked-api-tool-result.type.js +3 -0
- package/dist/types/linked-api-tool-result.type.js.map +1 -0
- package/dist/utils/handle-linked-api-error.d.ts.map +1 -1
- package/dist/utils/handle-linked-api-error.js +0 -19
- package/dist/utils/handle-linked-api-error.js.map +1 -1
- package/dist/utils/linked-api-tool.d.ts +5 -7
- package/dist/utils/linked-api-tool.d.ts.map +1 -1
- package/dist/utils/linked-api-tool.js +4 -9
- package/dist/utils/linked-api-tool.js.map +1 -1
- package/dist/utils/types.d.ts +0 -6
- package/dist/utils/types.d.ts.map +1 -1
- package/package.json +2 -2
- package/src/index.ts +0 -29
- package/src/linked-api-server.ts +44 -66
- package/src/linked-api-tools.ts +5 -13
- package/src/prompts/index.ts +3 -1
- package/src/tools/get-api-usage-stats.ts +0 -2
- package/src/tools/get-conversation.ts +9 -30
- package/src/tools/get-workflow-result.ts +63 -24
- package/src/tools/nv-get-conversation.ts +9 -30
- package/src/types/linked-api-tool-result.type.ts +12 -0
- package/src/utils/handle-linked-api-error.ts +1 -20
- package/src/utils/linked-api-tool.ts +11 -25
- package/src/utils/types.ts +0 -6
- package/dist/utils/execute-with-progress.d.ts +0 -13
- package/dist/utils/execute-with-progress.d.ts.map +0 -1
- package/dist/utils/execute-with-progress.js +0 -85
- package/dist/utils/execute-with-progress.js.map +0 -1
- package/src/utils/execute-with-progress.ts +0 -111
package/src/linked-api-tools.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import LinkedApi
|
|
1
|
+
import LinkedApi from '@linkedapi/node';
|
|
2
2
|
import { Tool } from '@modelcontextprotocol/sdk/types.js';
|
|
3
3
|
|
|
4
4
|
import { AdminConnectAccountTool } from './tools/admin-connect-account.js';
|
|
@@ -38,26 +38,18 @@ import { SearchPeopleTool } from './tools/search-people.js';
|
|
|
38
38
|
import { SendConnectionRequestTool } from './tools/send-connection-request.js';
|
|
39
39
|
import { SendMessageTool } from './tools/send-message.js';
|
|
40
40
|
import { WithdrawConnectionRequestTool } from './tools/withdraw-connection-request.js';
|
|
41
|
+
import type { TLinkedApiToolResult } from './types/linked-api-tool-result.type.js';
|
|
41
42
|
import { AdminTool } from './utils/admin-tool.js';
|
|
42
|
-
import { LinkedApiProgressNotification } from './utils/types.js';
|
|
43
43
|
|
|
44
44
|
interface TRegisteredLinkedApiTool {
|
|
45
45
|
readonly name: string;
|
|
46
46
|
getTool(): Tool;
|
|
47
47
|
validate(args: unknown): unknown;
|
|
48
|
-
execute({
|
|
49
|
-
linkedapi,
|
|
50
|
-
args,
|
|
51
|
-
workflowTimeout,
|
|
52
|
-
progressToken,
|
|
53
|
-
progressCallback,
|
|
54
|
-
}: {
|
|
48
|
+
execute(options: {
|
|
55
49
|
linkedapi: LinkedApi;
|
|
56
50
|
args: never;
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
progressCallback: (progress: LinkedApiProgressNotification) => void;
|
|
60
|
-
}): Promise<TMappedResponse<unknown>>;
|
|
51
|
+
mcpClient: string;
|
|
52
|
+
}): Promise<TLinkedApiToolResult<unknown>>;
|
|
61
53
|
}
|
|
62
54
|
|
|
63
55
|
export class LinkedApiTools {
|
package/src/prompts/index.ts
CHANGED
|
@@ -33,7 +33,7 @@ LINKEDIN WORKFLOWS RUN IN THE BACKGROUND:
|
|
|
33
33
|
- Simply continue listening for updates using get_workflow_result
|
|
34
34
|
|
|
35
35
|
WHEN A WORKFLOW IS RUNNING IN BACKGROUND:
|
|
36
|
-
1. You'll receive a status message with: workflowId and operationName
|
|
36
|
+
1. You'll receive a status message with: workflowId, status, message, and operationName
|
|
37
37
|
2. Use get_workflow_result(workflowId, operationName) to continue listening for updates
|
|
38
38
|
3. Keep listening until you get the final results
|
|
39
39
|
4. This is normal workflow operation - the task is actively running
|
|
@@ -41,6 +41,7 @@ WHEN A WORKFLOW IS RUNNING IN BACKGROUND:
|
|
|
41
41
|
EXAMPLE BACKGROUND WORKFLOW MESSAGE:
|
|
42
42
|
{
|
|
43
43
|
"message": "Workflow is running in the background. Continue listening for updates.",
|
|
44
|
+
"status": "running",
|
|
44
45
|
"workflowId": "account-12345-abcde",
|
|
45
46
|
"operationName": "searchCompanies"
|
|
46
47
|
}
|
|
@@ -113,6 +114,7 @@ WHAT TO DO WHEN WORKFLOW RUNS IN BACKGROUND:
|
|
|
113
114
|
EXAMPLE BACKGROUND WORKFLOW MESSAGE:
|
|
114
115
|
{
|
|
115
116
|
"message": "Workflow is running in the background. Continue listening for updates.",
|
|
117
|
+
"status": "running",
|
|
116
118
|
"workflowId": "account-12345-abcde",
|
|
117
119
|
"operationName": "searchCompanies"
|
|
118
120
|
}
|
|
@@ -17,8 +17,6 @@ export class GetApiUsageTool extends LinkedApiTool<TApiUsageParams, TApiUsageAct
|
|
|
17
17
|
}: {
|
|
18
18
|
linkedapi: LinkedApi;
|
|
19
19
|
args: TApiUsageParams;
|
|
20
|
-
workflowTimeout: number;
|
|
21
|
-
progressToken?: string | number;
|
|
22
20
|
}): Promise<TMappedResponse<TApiUsageAction[]>> {
|
|
23
21
|
return await linkedapi.getApiUsage(args);
|
|
24
22
|
}
|
|
@@ -1,14 +1,13 @@
|
|
|
1
1
|
import LinkedApi, {
|
|
2
|
-
|
|
2
|
+
OPERATION_NAME,
|
|
3
3
|
TConversationPollResult,
|
|
4
4
|
TMappedResponse,
|
|
5
5
|
} from '@linkedapi/node';
|
|
6
6
|
import { Tool } from '@modelcontextprotocol/sdk/types.js';
|
|
7
7
|
import z from 'zod';
|
|
8
8
|
|
|
9
|
-
import {
|
|
9
|
+
import type { TWorkflowAck } from '../types/linked-api-tool-result.type.js';
|
|
10
10
|
import { LinkedApiTool } from '../utils/linked-api-tool.js';
|
|
11
|
-
import { LinkedApiProgressNotification } from '../utils/types.js';
|
|
12
11
|
|
|
13
12
|
export class GetConversationTool extends LinkedApiTool<
|
|
14
13
|
{ personUrl: string; since?: string },
|
|
@@ -23,40 +22,20 @@ export class GetConversationTool extends LinkedApiTool<
|
|
|
23
22
|
public override async execute({
|
|
24
23
|
linkedapi,
|
|
25
24
|
args: { personUrl, since },
|
|
26
|
-
workflowTimeout,
|
|
27
|
-
progressToken,
|
|
28
|
-
progressCallback,
|
|
29
25
|
}: {
|
|
30
26
|
linkedapi: LinkedApi;
|
|
31
27
|
args: { personUrl: string; since?: string };
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
progressCallback: (progress: LinkedApiProgressNotification) => void;
|
|
35
|
-
}): Promise<TMappedResponse<TConversationPollResult>> {
|
|
36
|
-
const conversations = await this.getConversation(linkedapi, personUrl, since);
|
|
28
|
+
}): Promise<TMappedResponse<TConversationPollResult> | TWorkflowAck> {
|
|
29
|
+
const conversations = await this.pollConversation(linkedapi, personUrl, since);
|
|
37
30
|
if (conversations.errors.length === 0) {
|
|
38
31
|
return conversations;
|
|
39
32
|
}
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
operation: linkedapi.syncConversation,
|
|
44
|
-
workflowTimeout,
|
|
45
|
-
params: { personUrl },
|
|
46
|
-
progressToken,
|
|
47
|
-
});
|
|
48
|
-
} catch (error) {
|
|
49
|
-
if (error instanceof LinkedApiWorkflowTimeoutError) {
|
|
50
|
-
error.message = `${error.message}
|
|
51
|
-
|
|
52
|
-
After get_workflow_result completes this sync workflow, call get_conversation again with the same personUrl to read the synchronized messages.`;
|
|
53
|
-
}
|
|
54
|
-
throw error;
|
|
55
|
-
}
|
|
56
|
-
return await this.getConversation(linkedapi, personUrl, since);
|
|
33
|
+
const ack = await linkedapi.syncConversation.execute({ personUrl });
|
|
34
|
+
return { ...ack,
|
|
35
|
+
operationName: OPERATION_NAME.syncConversation };
|
|
57
36
|
}
|
|
58
37
|
|
|
59
|
-
private async
|
|
38
|
+
private async pollConversation(
|
|
60
39
|
linkedapi: LinkedApi,
|
|
61
40
|
personUrl: string,
|
|
62
41
|
since?: string,
|
|
@@ -78,7 +57,7 @@ After get_workflow_result completes this sync workflow, call get_conversation ag
|
|
|
78
57
|
return {
|
|
79
58
|
name: this.name,
|
|
80
59
|
description:
|
|
81
|
-
'
|
|
60
|
+
'Retrieve a conversation with a LinkedIn person via standard LinkedIn messaging. Returns the conversation immediately if it has already been synced. If the conversation has not been synced yet, this tool starts a syncConversation workflow and returns its ack ({status, workflowId, operationName: "syncConversation", message}); the client should call get_workflow_result with that workflowId until completion, then call get_conversation again to read the synced messages.',
|
|
82
61
|
inputSchema: {
|
|
83
62
|
type: 'object',
|
|
84
63
|
properties: {
|
|
@@ -1,14 +1,24 @@
|
|
|
1
|
-
import LinkedApi, {
|
|
1
|
+
import LinkedApi, {
|
|
2
|
+
Operation,
|
|
3
|
+
OPERATION_NAME,
|
|
4
|
+
TMappedResponse,
|
|
5
|
+
TOperationName,
|
|
6
|
+
TWorkflowInProgressResponse,
|
|
7
|
+
} from '@linkedapi/node';
|
|
2
8
|
import { Tool } from '@modelcontextprotocol/sdk/types.js';
|
|
3
9
|
import z from 'zod';
|
|
4
10
|
|
|
5
|
-
import {
|
|
11
|
+
import type { TWorkflowAck } from '../types/linked-api-tool-result.type.js';
|
|
12
|
+
import { defineRequestTimeoutInSeconds } from '../utils/define-request-timeout.js';
|
|
6
13
|
import { LinkedApiTool } from '../utils/linked-api-tool.js';
|
|
7
|
-
|
|
14
|
+
|
|
15
|
+
const POLL_INTERVAL_MS = 5000 as const;
|
|
16
|
+
const REQUEST_BUDGET_BUFFER_SECONDS = 5 as const;
|
|
8
17
|
|
|
9
18
|
interface IGetWorkflowResultParams {
|
|
10
19
|
workflowId: string;
|
|
11
20
|
operationName: string;
|
|
21
|
+
waitSeconds?: number;
|
|
12
22
|
}
|
|
13
23
|
|
|
14
24
|
export class GetWorkflowResultTool extends LinkedApiTool<IGetWorkflowResultParams, unknown> {
|
|
@@ -16,50 +26,66 @@ export class GetWorkflowResultTool extends LinkedApiTool<IGetWorkflowResultParam
|
|
|
16
26
|
protected readonly schema = z.object({
|
|
17
27
|
workflowId: z.string(),
|
|
18
28
|
operationName: z.enum(Object.values(OPERATION_NAME)),
|
|
29
|
+
waitSeconds: z.number().int().min(0).optional(),
|
|
19
30
|
});
|
|
20
31
|
|
|
21
32
|
public override async execute({
|
|
22
33
|
linkedapi,
|
|
23
|
-
args: { workflowId, operationName },
|
|
24
|
-
|
|
25
|
-
progressToken,
|
|
26
|
-
progressCallback,
|
|
34
|
+
args: { workflowId, operationName, waitSeconds },
|
|
35
|
+
mcpClient,
|
|
27
36
|
}: {
|
|
28
37
|
linkedapi: LinkedApi;
|
|
29
38
|
args: IGetWorkflowResultParams;
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
}): Promise<TMappedResponse<unknown>> {
|
|
39
|
+
mcpClient: string;
|
|
40
|
+
}): Promise<TMappedResponse<unknown> | TWorkflowAck> {
|
|
41
|
+
const typedOperationName = operationName as TOperationName;
|
|
34
42
|
const operation = linkedapi.operations.find(
|
|
35
|
-
(operation) => operation.operationName ===
|
|
36
|
-
)
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
43
|
+
(operation) => operation.operationName === typedOperationName,
|
|
44
|
+
)! as Operation<unknown, unknown>;
|
|
45
|
+
|
|
46
|
+
const cap = Math.max(
|
|
47
|
+
defineRequestTimeoutInSeconds(mcpClient) - REQUEST_BUDGET_BUFFER_SECONDS,
|
|
48
|
+
0,
|
|
49
|
+
);
|
|
50
|
+
const budgetSeconds = Math.min(waitSeconds ?? cap, cap);
|
|
51
|
+
const deadline = Date.now() + budgetSeconds * 1000;
|
|
52
|
+
|
|
53
|
+
while (true) {
|
|
54
|
+
const status = await operation.status(workflowId);
|
|
55
|
+
if (!isWorkflowInProgress(status)) {
|
|
56
|
+
return status;
|
|
57
|
+
}
|
|
58
|
+
const remainingMs = deadline - Date.now();
|
|
59
|
+
if (remainingMs <= 0) {
|
|
60
|
+
return { ...status,
|
|
61
|
+
workflowId,
|
|
62
|
+
operationName: typedOperationName };
|
|
63
|
+
}
|
|
64
|
+
await sleep(Math.min(POLL_INTERVAL_MS, remainingMs));
|
|
65
|
+
}
|
|
44
66
|
}
|
|
45
67
|
|
|
46
68
|
public override getTool(): Tool {
|
|
47
69
|
return {
|
|
48
70
|
name: this.name,
|
|
49
71
|
description:
|
|
50
|
-
'
|
|
72
|
+
'Check the current state of a previously started Linked API workflow. Returns the final result when the workflow has completed, otherwise returns the current in-progress snapshot ({status, workflowId, operationName, message}). The server long-polls up to waitSeconds while the workflow is still running; if the budget elapses without completion, the in-progress snapshot is returned and the client should call this tool again with the same workflowId and operationName.',
|
|
51
73
|
inputSchema: {
|
|
52
74
|
type: 'object',
|
|
53
75
|
properties: {
|
|
54
76
|
workflowId: {
|
|
55
77
|
type: 'string',
|
|
56
|
-
description:
|
|
57
|
-
'Required. The workflow ID provided in the background workflow status message.',
|
|
78
|
+
description: 'Required. The workflow ID returned by the original Linked API tool call.',
|
|
58
79
|
},
|
|
59
80
|
operationName: {
|
|
60
81
|
type: 'string',
|
|
61
82
|
description:
|
|
62
|
-
'Required. The operationName
|
|
83
|
+
'Required. The operationName returned by the original Linked API tool call. Used to map the response to the right operation.',
|
|
84
|
+
},
|
|
85
|
+
waitSeconds: {
|
|
86
|
+
type: 'number',
|
|
87
|
+
description:
|
|
88
|
+
'Optional. Maximum seconds the server should wait for the workflow to complete before returning the current in-progress snapshot. Defaults to the maximum the current MCP client allows; pass 0 to get an immediate one-shot snapshot.',
|
|
63
89
|
},
|
|
64
90
|
},
|
|
65
91
|
required: ['workflowId', 'operationName'],
|
|
@@ -67,3 +93,16 @@ export class GetWorkflowResultTool extends LinkedApiTool<IGetWorkflowResultParam
|
|
|
67
93
|
};
|
|
68
94
|
}
|
|
69
95
|
}
|
|
96
|
+
|
|
97
|
+
function isWorkflowInProgress(
|
|
98
|
+
result: TMappedResponse<unknown> | TWorkflowInProgressResponse,
|
|
99
|
+
): result is TWorkflowInProgressResponse {
|
|
100
|
+
return (
|
|
101
|
+
'workflowStatus' in result &&
|
|
102
|
+
(result.workflowStatus === 'running' || result.workflowStatus === 'pending')
|
|
103
|
+
);
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
function sleep(ms: number): Promise<void> {
|
|
107
|
+
return new Promise((resolve) => setTimeout(resolve, ms));
|
|
108
|
+
}
|
|
@@ -1,14 +1,13 @@
|
|
|
1
1
|
import LinkedApi, {
|
|
2
|
-
|
|
2
|
+
OPERATION_NAME,
|
|
3
3
|
TConversationPollResult,
|
|
4
4
|
TMappedResponse,
|
|
5
5
|
} from '@linkedapi/node';
|
|
6
6
|
import { Tool } from '@modelcontextprotocol/sdk/types.js';
|
|
7
7
|
import z from 'zod';
|
|
8
8
|
|
|
9
|
-
import {
|
|
9
|
+
import type { TWorkflowAck } from '../types/linked-api-tool-result.type.js';
|
|
10
10
|
import { LinkedApiTool } from '../utils/linked-api-tool.js';
|
|
11
|
-
import { LinkedApiProgressNotification } from '../utils/types.js';
|
|
12
11
|
|
|
13
12
|
export class NvGetConversationTool extends LinkedApiTool<
|
|
14
13
|
{ personUrl: string; since?: string },
|
|
@@ -23,40 +22,20 @@ export class NvGetConversationTool extends LinkedApiTool<
|
|
|
23
22
|
public override async execute({
|
|
24
23
|
linkedapi,
|
|
25
24
|
args: { personUrl, since },
|
|
26
|
-
workflowTimeout,
|
|
27
|
-
progressToken,
|
|
28
|
-
progressCallback,
|
|
29
25
|
}: {
|
|
30
26
|
linkedapi: LinkedApi;
|
|
31
27
|
args: { personUrl: string; since?: string };
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
progressCallback: (progress: LinkedApiProgressNotification) => void;
|
|
35
|
-
}): Promise<TMappedResponse<TConversationPollResult>> {
|
|
36
|
-
const conversations = await this.getConversation(linkedapi, personUrl, since);
|
|
28
|
+
}): Promise<TMappedResponse<TConversationPollResult> | TWorkflowAck> {
|
|
29
|
+
const conversations = await this.pollConversation(linkedapi, personUrl, since);
|
|
37
30
|
if (conversations.errors.length === 0) {
|
|
38
31
|
return conversations;
|
|
39
32
|
}
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
operation: linkedapi.nvSyncConversation,
|
|
44
|
-
workflowTimeout,
|
|
45
|
-
params: { personUrl },
|
|
46
|
-
progressToken,
|
|
47
|
-
});
|
|
48
|
-
} catch (error) {
|
|
49
|
-
if (error instanceof LinkedApiWorkflowTimeoutError) {
|
|
50
|
-
error.message = `${error.message}
|
|
51
|
-
|
|
52
|
-
After get_workflow_result completes this sync workflow, call nv_get_conversation again with the same personUrl to read the synchronized messages.`;
|
|
53
|
-
}
|
|
54
|
-
throw error;
|
|
55
|
-
}
|
|
56
|
-
return await this.getConversation(linkedapi, personUrl, since);
|
|
33
|
+
const ack = await linkedapi.nvSyncConversation.execute({ personUrl });
|
|
34
|
+
return { ...ack,
|
|
35
|
+
operationName: OPERATION_NAME.nvSyncConversation };
|
|
57
36
|
}
|
|
58
37
|
|
|
59
|
-
private async
|
|
38
|
+
private async pollConversation(
|
|
60
39
|
linkedapi: LinkedApi,
|
|
61
40
|
personUrl: string,
|
|
62
41
|
since?: string,
|
|
@@ -78,7 +57,7 @@ After get_workflow_result completes this sync workflow, call nv_get_conversation
|
|
|
78
57
|
return {
|
|
79
58
|
name: this.name,
|
|
80
59
|
description:
|
|
81
|
-
'
|
|
60
|
+
'Retrieve a conversation with a LinkedIn person via Sales Navigator messaging. Returns the conversation immediately if it has already been synced. If the conversation has not been synced yet, this tool starts an nvSyncConversation workflow and returns its ack ({status, workflowId, operationName: "nvSyncConversation", message}); the client should call get_workflow_result with that workflowId until completion, then call nv_get_conversation again to read the synced messages.',
|
|
82
61
|
inputSchema: {
|
|
83
62
|
type: 'object',
|
|
84
63
|
properties: {
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type {
|
|
2
|
+
TMappedResponse,
|
|
3
|
+
TOperationName,
|
|
4
|
+
TWorkflowInProgressResponse,
|
|
5
|
+
TWorkflowStartedResponse,
|
|
6
|
+
} from '@linkedapi/node';
|
|
7
|
+
|
|
8
|
+
export type TWorkflowAck = (TWorkflowStartedResponse | TWorkflowInProgressResponse) & {
|
|
9
|
+
operationName: TOperationName;
|
|
10
|
+
};
|
|
11
|
+
|
|
12
|
+
export type TLinkedApiToolResult<TResult> = TWorkflowAck | TMappedResponse<TResult>;
|
|
@@ -1,27 +1,8 @@
|
|
|
1
|
-
import { LinkedApiError
|
|
1
|
+
import { LinkedApiError } from '@linkedapi/node';
|
|
2
2
|
|
|
3
3
|
import { authenticationPrompt } from '../prompts';
|
|
4
4
|
|
|
5
5
|
export function handleLinkedApiError(error: LinkedApiError): Record<string, unknown> {
|
|
6
|
-
if (error instanceof LinkedApiWorkflowTimeoutError) {
|
|
7
|
-
const { message, workflowId, operationName } = error;
|
|
8
|
-
return {
|
|
9
|
-
status: 'workflow_running',
|
|
10
|
-
message,
|
|
11
|
-
workflowId,
|
|
12
|
-
operationName,
|
|
13
|
-
nextAction: {
|
|
14
|
-
tool: 'get_workflow_result',
|
|
15
|
-
arguments: {
|
|
16
|
-
workflowId,
|
|
17
|
-
operationName,
|
|
18
|
-
},
|
|
19
|
-
repeatUntil: 'final data is returned or the tool returns Completed',
|
|
20
|
-
},
|
|
21
|
-
userMessage:
|
|
22
|
-
'Linked API is still working through the cloud-browser workflow. I will keep checking the existing workflow instead of starting a duplicate request.',
|
|
23
|
-
};
|
|
24
|
-
}
|
|
25
6
|
switch (error.type) {
|
|
26
7
|
case 'identificationTokenRequired':
|
|
27
8
|
case 'linkedApiTokenRequired':
|
|
@@ -1,16 +1,13 @@
|
|
|
1
|
-
import LinkedApi, { Operation,
|
|
1
|
+
import LinkedApi, { Operation, TOperationName } from '@linkedapi/node';
|
|
2
2
|
import { Tool } from '@modelcontextprotocol/sdk/types.js';
|
|
3
|
-
import { LinkedApiProgressNotification } from 'src/utils/types';
|
|
4
3
|
import z from 'zod';
|
|
5
4
|
|
|
6
|
-
import {
|
|
5
|
+
import type { TLinkedApiToolResult, TWorkflowAck } from '../types/linked-api-tool-result.type.js';
|
|
7
6
|
|
|
8
7
|
interface TLinkedApiToolExecuteOptions<TParams> {
|
|
9
8
|
linkedapi: LinkedApi;
|
|
10
9
|
args: TParams;
|
|
11
|
-
|
|
12
|
-
progressToken?: string | number;
|
|
13
|
-
progressCallback: (progress: LinkedApiProgressNotification) => void;
|
|
10
|
+
mcpClient: string;
|
|
14
11
|
}
|
|
15
12
|
|
|
16
13
|
export abstract class LinkedApiTool<TParams, TResult> {
|
|
@@ -23,34 +20,23 @@ export abstract class LinkedApiTool<TParams, TResult> {
|
|
|
23
20
|
return this.schema.parse(args) as TParams;
|
|
24
21
|
}
|
|
25
22
|
|
|
26
|
-
public abstract execute(
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
workflowTimeout,
|
|
30
|
-
progressToken,
|
|
31
|
-
progressCallback,
|
|
32
|
-
}: TLinkedApiToolExecuteOptions<TParams>): Promise<TMappedResponse<TResult>>;
|
|
23
|
+
public abstract execute(
|
|
24
|
+
options: TLinkedApiToolExecuteOptions<TParams>,
|
|
25
|
+
): Promise<TLinkedApiToolResult<TResult>>;
|
|
33
26
|
}
|
|
34
27
|
|
|
35
28
|
export abstract class OperationTool<TParams, TResult> extends LinkedApiTool<TParams, TResult> {
|
|
36
29
|
public abstract readonly operationName: TOperationName;
|
|
37
30
|
|
|
38
|
-
public override execute({
|
|
31
|
+
public override async execute({
|
|
39
32
|
linkedapi,
|
|
40
33
|
args,
|
|
41
|
-
|
|
42
|
-
progressToken,
|
|
43
|
-
progressCallback,
|
|
44
|
-
}: TLinkedApiToolExecuteOptions<TParams>): Promise<TMappedResponse<TResult>> {
|
|
34
|
+
}: TLinkedApiToolExecuteOptions<TParams>): Promise<TWorkflowAck> {
|
|
45
35
|
const operation = linkedapi.operations.find(
|
|
46
36
|
(operation) => operation.operationName === this.operationName,
|
|
47
37
|
)! as Operation<TParams, TResult>;
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
workflowTimeout,
|
|
52
|
-
params: args,
|
|
53
|
-
progressToken,
|
|
54
|
-
});
|
|
38
|
+
const response = await operation.execute(args);
|
|
39
|
+
return { ...response,
|
|
40
|
+
operationName: this.operationName };
|
|
55
41
|
}
|
|
56
42
|
}
|
package/src/utils/types.ts
CHANGED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import { Operation, TMappedResponse } from '@linkedapi/node';
|
|
2
|
-
import { LinkedApiProgressNotification } from './types';
|
|
3
|
-
interface TExecuteWithProgressOptions<TParams, TResult> {
|
|
4
|
-
progressCallback: (progress: LinkedApiProgressNotification) => void;
|
|
5
|
-
operation: Operation<TParams, TResult>;
|
|
6
|
-
workflowTimeout: number;
|
|
7
|
-
params?: TParams;
|
|
8
|
-
workflowId?: string;
|
|
9
|
-
progressToken?: string | number;
|
|
10
|
-
}
|
|
11
|
-
export declare function executeWithProgress<TParams, TResult>({ progressCallback, operation, workflowTimeout, params, workflowId, progressToken, }: TExecuteWithProgressOptions<TParams, TResult>): Promise<TMappedResponse<TResult>>;
|
|
12
|
-
export {};
|
|
13
|
-
//# sourceMappingURL=execute-with-progress.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"execute-with-progress.d.ts","sourceRoot":"","sources":["../../src/utils/execute-with-progress.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiC,SAAS,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAE5F,OAAO,EAAE,6BAA6B,EAAE,MAAM,SAAS,CAAC;AAKxD,UAAU,2BAA2B,CAAC,OAAO,EAAE,OAAO;IACpD,gBAAgB,EAAE,CAAC,QAAQ,EAAE,6BAA6B,KAAK,IAAI,CAAC;IACpE,SAAS,EAAE,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvC,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACjC;AAED,wBAAsB,mBAAmB,CAAC,OAAO,EAAE,OAAO,EAAE,EAC1D,gBAAgB,EAChB,SAAS,EACT,eAAe,EACf,MAAM,EACN,UAAU,EACV,aAAa,GACd,EAAE,2BAA2B,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CA2DnF"}
|
|
@@ -1,85 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.executeWithProgress = executeWithProgress;
|
|
4
|
-
const node_1 = require("@linkedapi/node");
|
|
5
|
-
const WORKFLOW_PROGRESS_TOTAL = 100;
|
|
6
|
-
const MIN_PROGRESS_INTERVAL = 10000;
|
|
7
|
-
async function executeWithProgress({ progressCallback, operation, workflowTimeout, params, workflowId, progressToken, }) {
|
|
8
|
-
let progress = 0;
|
|
9
|
-
progressCallback({
|
|
10
|
-
progressToken,
|
|
11
|
-
progress,
|
|
12
|
-
total: WORKFLOW_PROGRESS_TOTAL,
|
|
13
|
-
message: `Starting Linked API workflow ${operation.operationName}. The action may enter the cloud-browser queue and take several minutes.`,
|
|
14
|
-
});
|
|
15
|
-
const interval = setInterval(() => {
|
|
16
|
-
if (progress < 50) {
|
|
17
|
-
progress += 5;
|
|
18
|
-
}
|
|
19
|
-
else if (progress < 98) {
|
|
20
|
-
progress += 1;
|
|
21
|
-
}
|
|
22
|
-
progressCallback({
|
|
23
|
-
progressToken,
|
|
24
|
-
progress,
|
|
25
|
-
total: WORKFLOW_PROGRESS_TOTAL,
|
|
26
|
-
message: `Waiting for workflow ${operation.operationName}. Linked API is still processing it in the background.`,
|
|
27
|
-
});
|
|
28
|
-
}, Math.max(workflowTimeout / 20, MIN_PROGRESS_INTERVAL));
|
|
29
|
-
try {
|
|
30
|
-
if (!workflowId) {
|
|
31
|
-
workflowId = await operation.execute(params);
|
|
32
|
-
progressCallback({
|
|
33
|
-
progressToken,
|
|
34
|
-
progress,
|
|
35
|
-
total: WORKFLOW_PROGRESS_TOTAL,
|
|
36
|
-
message: `Workflow ${operation.operationName} is queued or running in the background. workflowId: ${workflowId}.`,
|
|
37
|
-
});
|
|
38
|
-
}
|
|
39
|
-
const result = await operation.result(workflowId, {
|
|
40
|
-
timeout: workflowTimeout,
|
|
41
|
-
});
|
|
42
|
-
clearInterval(interval);
|
|
43
|
-
progressCallback({
|
|
44
|
-
progressToken,
|
|
45
|
-
progress: WORKFLOW_PROGRESS_TOTAL,
|
|
46
|
-
total: WORKFLOW_PROGRESS_TOTAL,
|
|
47
|
-
message: `Workflow ${operation.operationName} completed successfully`,
|
|
48
|
-
});
|
|
49
|
-
return result;
|
|
50
|
-
}
|
|
51
|
-
catch (error) {
|
|
52
|
-
clearInterval(interval);
|
|
53
|
-
if (error instanceof node_1.LinkedApiWorkflowTimeoutError) {
|
|
54
|
-
throw generateTimeoutError(error);
|
|
55
|
-
}
|
|
56
|
-
throw error;
|
|
57
|
-
}
|
|
58
|
-
}
|
|
59
|
-
function generateTimeoutError(error) {
|
|
60
|
-
const restoreMessage = `Workflow is still running in Linked API's cloud-browser queue or background worker.
|
|
61
|
-
|
|
62
|
-
This is not a failure. The original tool already started the workflow, so retrying it can create duplicate queued work.
|
|
63
|
-
|
|
64
|
-
ACTION REQUIRED (MCP CLIENT):
|
|
65
|
-
- Do not retry the original tool; the workflow is already running
|
|
66
|
-
- Call the get_workflow_result tool with the parameters below and keep listening until completion
|
|
67
|
-
|
|
68
|
-
PARAMETERS TO USE:
|
|
69
|
-
- workflowId: ${error.workflowId}
|
|
70
|
-
- operationName: ${error.operationName}
|
|
71
|
-
|
|
72
|
-
GENERIC MCP CALL EXAMPLE:
|
|
73
|
-
{
|
|
74
|
-
"name": "get_workflow_result",
|
|
75
|
-
"arguments": {
|
|
76
|
-
"workflowId": "${error.workflowId}",
|
|
77
|
-
"operationName": "${error.operationName}"
|
|
78
|
-
}
|
|
79
|
-
}
|
|
80
|
-
|
|
81
|
-
Background processing keeps the MCP client responsive while the workflow completes.`;
|
|
82
|
-
error.message = restoreMessage;
|
|
83
|
-
return error;
|
|
84
|
-
}
|
|
85
|
-
//# sourceMappingURL=execute-with-progress.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"execute-with-progress.js","sourceRoot":"","sources":["../../src/utils/execute-with-progress.ts"],"names":[],"mappings":";;AAgBA,kDAkEC;AAlFD,0CAA4F;AAI5F,MAAM,uBAAuB,GAAG,GAAY,CAAC;AAC7C,MAAM,qBAAqB,GAAG,KAAc,CAAC;AAWtC,KAAK,UAAU,mBAAmB,CAAmB,EAC1D,gBAAgB,EAChB,SAAS,EACT,eAAe,EACf,MAAM,EACN,UAAU,EACV,aAAa,GACiC;IAC9C,IAAI,QAAQ,GAAG,CAAC,CAAC;IAEjB,gBAAgB,CAAC;QACf,aAAa;QACb,QAAQ;QACR,KAAK,EAAE,uBAAuB;QAC9B,OAAO,EAAE,gCAAgC,SAAS,CAAC,aAAa,0EAA0E;KAC3I,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,WAAW,CAC1B,GAAG,EAAE;QACH,IAAI,QAAQ,GAAG,EAAE,EAAE,CAAC;YAClB,QAAQ,IAAI,CAAC,CAAC;QAChB,CAAC;aAAM,IAAI,QAAQ,GAAG,EAAE,EAAE,CAAC;YACzB,QAAQ,IAAI,CAAC,CAAC;QAChB,CAAC;QAED,gBAAgB,CAAC;YACf,aAAa;YACb,QAAQ;YACR,KAAK,EAAE,uBAAuB;YAC9B,OAAO,EAAE,wBAAwB,SAAS,CAAC,aAAa,wDAAwD;SACjH,CAAC,CAAC;IACL,CAAC,EACD,IAAI,CAAC,GAAG,CAAC,eAAe,GAAG,EAAE,EAAE,qBAAqB,CAAC,CACtD,CAAC;IAEF,IAAI,CAAC;QACH,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,UAAU,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,MAAiB,CAAC,CAAC;YACxD,gBAAgB,CAAC;gBACf,aAAa;gBACb,QAAQ;gBACR,KAAK,EAAE,uBAAuB;gBAC9B,OAAO,EAAE,YAAY,SAAS,CAAC,aAAa,wDAAwD,UAAU,GAAG;aAClH,CAAC,CAAC;QACL,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,UAAU,EAAE;YAChD,OAAO,EAAE,eAAe;SACzB,CAAC,CAAC;QACH,aAAa,CAAC,QAAQ,CAAC,CAAC;QAExB,gBAAgB,CAAC;YACf,aAAa;YACb,QAAQ,EAAE,uBAAuB;YACjC,KAAK,EAAE,uBAAuB;YAC9B,OAAO,EAAE,YAAY,SAAS,CAAC,aAAa,yBAAyB;SACtE,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,aAAa,CAAC,QAAQ,CAAC,CAAC;QACxB,IAAI,KAAK,YAAY,oCAA6B,EAAE,CAAC;YACnD,MAAM,oBAAoB,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;QAED,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAoC;IAChE,MAAM,cAAc,GAAG;;;;;;;;;gBAST,KAAK,CAAC,UAAU;mBACb,KAAK,CAAC,aAAa;;;;;;qBAMjB,KAAK,CAAC,UAAU;wBACb,KAAK,CAAC,aAAa;;;;oFAIyC,CAAC;IAEnF,KAAK,CAAC,OAAO,GAAG,cAAc,CAAC;IAC/B,OAAO,KAAK,CAAC;AACf,CAAC"}
|