@llamaindex/llama-cloud-mcp 1.7.0 → 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.
Files changed (93) hide show
  1. package/code-tool-paths.cjs +4 -2
  2. package/code-tool-paths.cjs.map +1 -1
  3. package/code-tool-paths.d.cts +1 -1
  4. package/code-tool-paths.d.cts.map +1 -1
  5. package/code-tool-worker.d.mts.map +1 -1
  6. package/code-tool-worker.d.ts.map +1 -1
  7. package/code-tool-worker.js +9 -17
  8. package/code-tool-worker.js.map +1 -1
  9. package/code-tool-worker.mjs +9 -17
  10. package/code-tool-worker.mjs.map +1 -1
  11. package/code-tool.d.mts.map +1 -1
  12. package/code-tool.d.ts.map +1 -1
  13. package/code-tool.js +29 -23
  14. package/code-tool.js.map +1 -1
  15. package/code-tool.mjs +20 -11
  16. package/code-tool.mjs.map +1 -1
  17. package/docs-search-tool.d.mts +2 -0
  18. package/docs-search-tool.d.mts.map +1 -1
  19. package/docs-search-tool.d.ts +2 -0
  20. package/docs-search-tool.d.ts.map +1 -1
  21. package/docs-search-tool.js +33 -3
  22. package/docs-search-tool.js.map +1 -1
  23. package/docs-search-tool.mjs +32 -3
  24. package/docs-search-tool.mjs.map +1 -1
  25. package/http.d.mts.map +1 -1
  26. package/http.d.ts.map +1 -1
  27. package/http.js +58 -3
  28. package/http.js.map +1 -1
  29. package/http.mjs +58 -3
  30. package/http.mjs.map +1 -1
  31. package/instructions.d.mts +4 -1
  32. package/instructions.d.mts.map +1 -1
  33. package/instructions.d.ts +4 -1
  34. package/instructions.d.ts.map +1 -1
  35. package/instructions.js +30 -25
  36. package/instructions.js.map +1 -1
  37. package/instructions.mjs +27 -25
  38. package/instructions.mjs.map +1 -1
  39. package/local-docs-search.d.mts +28 -0
  40. package/local-docs-search.d.mts.map +1 -0
  41. package/local-docs-search.d.ts +28 -0
  42. package/local-docs-search.d.ts.map +1 -0
  43. package/local-docs-search.js +3603 -0
  44. package/local-docs-search.js.map +1 -0
  45. package/local-docs-search.mjs +3563 -0
  46. package/local-docs-search.mjs.map +1 -0
  47. package/methods.d.mts.map +1 -1
  48. package/methods.d.ts.map +1 -1
  49. package/methods.js +36 -84
  50. package/methods.js.map +1 -1
  51. package/methods.mjs +36 -84
  52. package/methods.mjs.map +1 -1
  53. package/options.d.mts +3 -0
  54. package/options.d.mts.map +1 -1
  55. package/options.d.ts +3 -0
  56. package/options.d.ts.map +1 -1
  57. package/options.js +19 -0
  58. package/options.js.map +1 -1
  59. package/options.mjs +19 -0
  60. package/options.mjs.map +1 -1
  61. package/package.json +19 -5
  62. package/server.d.mts +10 -1
  63. package/server.d.mts.map +1 -1
  64. package/server.d.ts +10 -1
  65. package/server.d.ts.map +1 -1
  66. package/server.js +13 -3
  67. package/server.js.map +1 -1
  68. package/server.mjs +13 -3
  69. package/server.mjs.map +1 -1
  70. package/src/code-tool-paths.cts +3 -1
  71. package/src/code-tool-worker.ts +9 -17
  72. package/src/code-tool.ts +27 -16
  73. package/src/docs-search-tool.ts +48 -9
  74. package/src/http.ts +62 -3
  75. package/src/instructions.ts +34 -26
  76. package/src/local-docs-search.ts +4218 -0
  77. package/src/methods.ts +36 -84
  78. package/src/options.ts +24 -0
  79. package/src/server.ts +23 -3
  80. package/src/stdio.ts +4 -1
  81. package/src/types.ts +3 -0
  82. package/stdio.d.mts.map +1 -1
  83. package/stdio.d.ts.map +1 -1
  84. package/stdio.js +4 -1
  85. package/stdio.js.map +1 -1
  86. package/stdio.mjs +4 -1
  87. package/stdio.mjs.map +1 -1
  88. package/types.d.mts +6 -0
  89. package/types.d.mts.map +1 -1
  90. package/types.d.ts +6 -0
  91. package/types.d.ts.map +1 -1
  92. package/types.js.map +1 -1
  93. package/types.mjs.map +1 -1
@@ -3,6 +3,7 @@
3
3
  import { Tool } from '@modelcontextprotocol/sdk/types.js';
4
4
  import { Metadata, McpRequestContext, asTextContentResult } from './types';
5
5
  import { getLogger } from './logger';
6
+ import type { LocalDocsSearch } from './local-docs-search';
6
7
 
7
8
  export const metadata: Metadata = {
8
9
  resource: 'all',
@@ -13,7 +14,8 @@ export const metadata: Metadata = {
13
14
 
14
15
  export const tool: Tool = {
15
16
  name: 'search_docs',
16
- description: 'Search for documentation for how to use the client to interact with the API.',
17
+ description:
18
+ 'Search SDK documentation to find methods, parameters, and usage examples for interacting with the API. Use this before writing code when you need to discover the right approach.',
17
19
  inputSchema: {
18
20
  type: 'object',
19
21
  properties: {
@@ -42,13 +44,30 @@ export const tool: Tool = {
42
44
  const docsSearchURL =
43
45
  process.env['DOCS_SEARCH_URL'] || 'https://api.stainless.com/api/projects/llamacloud-prod/docs/search';
44
46
 
45
- export const handler = async ({
46
- reqContext,
47
- args,
48
- }: {
49
- reqContext: McpRequestContext;
50
- args: Record<string, unknown> | undefined;
51
- }) => {
47
+ let _localSearch: LocalDocsSearch | undefined;
48
+
49
+ export function setLocalSearch(search: LocalDocsSearch): void {
50
+ _localSearch = search;
51
+ }
52
+
53
+ async function searchLocal(args: Record<string, unknown>): Promise<unknown> {
54
+ if (!_localSearch) {
55
+ throw new Error('Local search not initialized');
56
+ }
57
+
58
+ const query = (args['query'] as string) ?? '';
59
+ const language = (args['language'] as string) ?? 'typescript';
60
+ const detail = (args['detail'] as string) ?? 'default';
61
+
62
+ return _localSearch.search({
63
+ query,
64
+ language,
65
+ detail,
66
+ maxResults: 5,
67
+ }).results;
68
+ }
69
+
70
+ async function searchRemote(args: Record<string, unknown>, reqContext: McpRequestContext): Promise<unknown> {
52
71
  const body = args as any;
53
72
  const query = new URLSearchParams(body).toString();
54
73
 
@@ -56,6 +75,10 @@ export const handler = async ({
56
75
  const result = await fetch(`${docsSearchURL}?${query}`, {
57
76
  headers: {
58
77
  ...(reqContext.stainlessApiKey && { Authorization: reqContext.stainlessApiKey }),
78
+ ...(reqContext.mcpSessionId && { 'x-stainless-mcp-session-id': reqContext.mcpSessionId }),
79
+ ...(reqContext.mcpClientInfo && {
80
+ 'x-stainless-mcp-client-info': JSON.stringify(reqContext.mcpClientInfo),
81
+ }),
59
82
  },
60
83
  });
61
84
 
@@ -93,7 +116,23 @@ export const handler = async ({
93
116
  },
94
117
  'Got docs search result',
95
118
  );
96
- return asTextContentResult(resultBody);
119
+ return resultBody;
120
+ }
121
+
122
+ export const handler = async ({
123
+ reqContext,
124
+ args,
125
+ }: {
126
+ reqContext: McpRequestContext;
127
+ args: Record<string, unknown> | undefined;
128
+ }) => {
129
+ const body = args ?? {};
130
+
131
+ if (_localSearch) {
132
+ return asTextContentResult(await searchLocal(body));
133
+ }
134
+
135
+ return asTextContentResult(await searchRemote(body, reqContext));
97
136
  };
98
137
 
99
138
  export default { metadata, tool, handler };
package/src/http.ts CHANGED
@@ -23,18 +23,66 @@ const newServer = async ({
23
23
  res: express.Response;
24
24
  }): Promise<McpServer | null> => {
25
25
  const stainlessApiKey = getStainlessApiKey(req, mcpOptions);
26
- const server = await newMcpServer(stainlessApiKey);
26
+ const customInstructionsPath = mcpOptions.customInstructionsPath;
27
+ const server = await newMcpServer({ stainlessApiKey, customInstructionsPath });
27
28
 
28
29
  const authOptions = parseClientAuthHeaders(req, false);
29
30
 
31
+ let upstreamClientEnvs: Record<string, string> | undefined;
32
+ const clientEnvsHeader = req.headers['x-stainless-mcp-client-envs'];
33
+ if (typeof clientEnvsHeader === 'string') {
34
+ try {
35
+ const parsed = JSON.parse(clientEnvsHeader);
36
+ if (parsed && typeof parsed === 'object' && !Array.isArray(parsed)) {
37
+ upstreamClientEnvs = parsed;
38
+ }
39
+ } catch {
40
+ // Ignore malformed header
41
+ }
42
+ }
43
+
44
+ // Parse x-stainless-mcp-client-permissions header to override permission options
45
+ //
46
+ // Note: Permissions are best-effort and intended to prevent clients from doing unexpected things;
47
+ // they're not a hard security boundary, so we allow arbitrary, client-driven overrides.
48
+ //
49
+ // See the Stainless MCP documentation for more details.
50
+ let effectiveMcpOptions = mcpOptions;
51
+ const clientPermissionsHeader = req.headers['x-stainless-mcp-client-permissions'];
52
+ if (typeof clientPermissionsHeader === 'string') {
53
+ try {
54
+ const parsed = JSON.parse(clientPermissionsHeader);
55
+ if (parsed && typeof parsed === 'object' && !Array.isArray(parsed)) {
56
+ effectiveMcpOptions = {
57
+ ...mcpOptions,
58
+ ...(typeof parsed.allow_http_gets === 'boolean' && { codeAllowHttpGets: parsed.allow_http_gets }),
59
+ ...(Array.isArray(parsed.allowed_methods) && { codeAllowedMethods: parsed.allowed_methods }),
60
+ ...(Array.isArray(parsed.blocked_methods) && { codeBlockedMethods: parsed.blocked_methods }),
61
+ };
62
+ getLogger().info(
63
+ { clientPermissions: parsed },
64
+ 'Overriding code execution permissions from x-stainless-mcp-client-permissions header',
65
+ );
66
+ }
67
+ } catch (error) {
68
+ getLogger().warn({ error }, 'Failed to parse x-stainless-mcp-client-permissions header');
69
+ }
70
+ }
71
+
30
72
  await initMcpServer({
31
73
  server: server,
32
- mcpOptions: mcpOptions,
74
+ mcpOptions: effectiveMcpOptions,
33
75
  clientOptions: {
34
76
  ...clientOptions,
35
77
  ...authOptions,
36
78
  },
37
79
  stainlessApiKey: stainlessApiKey,
80
+ upstreamClientEnvs,
81
+ mcpSessionId: (req as any).mcpSessionId,
82
+ mcpClientInfo:
83
+ typeof req.body?.params?.clientInfo?.name === 'string' ?
84
+ { name: req.body.params.clientInfo.name, version: String(req.body.params.clientInfo.version ?? '') }
85
+ : undefined,
38
86
  });
39
87
 
40
88
  return server;
@@ -72,7 +120,7 @@ const del = async (req: express.Request, res: express.Response) => {
72
120
  };
73
121
 
74
122
  const redactHeaders = (headers: Record<string, any>) => {
75
- const hiddenHeaders = /auth|cookie|key|token/i;
123
+ const hiddenHeaders = /auth|cookie|key|token|x-stainless-mcp-client-envs/i;
76
124
  const filtered = { ...headers };
77
125
  Object.keys(filtered).forEach((key) => {
78
126
  if (hiddenHeaders.test(key)) {
@@ -92,6 +140,17 @@ export const streamableHTTPApp = ({
92
140
  const app = express();
93
141
  app.set('query parser', 'extended');
94
142
  app.use(express.json());
143
+ app.use((req: express.Request, res: express.Response, next: express.NextFunction) => {
144
+ const existing = req.headers['mcp-session-id'];
145
+ const sessionId = (Array.isArray(existing) ? existing[0] : existing) || crypto.randomUUID();
146
+ (req as any).mcpSessionId = sessionId;
147
+ const origWriteHead = res.writeHead.bind(res);
148
+ res.writeHead = function (statusCode: number, ...rest: any[]) {
149
+ res.setHeader('mcp-session-id', sessionId);
150
+ return origWriteHead(statusCode, ...rest);
151
+ } as typeof res.writeHead;
152
+ next();
153
+ });
95
154
  app.use(
96
155
  pinoHttp({
97
156
  logger: getLogger(),
@@ -1,5 +1,6 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
+ import fs from 'fs/promises';
3
4
  import { readEnv } from './util';
4
5
  import { getLogger } from './logger';
5
6
 
@@ -12,33 +13,50 @@ interface InstructionsCacheEntry {
12
13
 
13
14
  const instructionsCache = new Map<string, InstructionsCacheEntry>();
14
15
 
15
- // Periodically evict stale entries so the cache doesn't grow unboundedly.
16
- const _cacheCleanupInterval = setInterval(() => {
16
+ export async function getInstructions({
17
+ stainlessApiKey,
18
+ customInstructionsPath,
19
+ }: {
20
+ stainlessApiKey?: string | undefined;
21
+ customInstructionsPath?: string | undefined;
22
+ }): Promise<string> {
17
23
  const now = Date.now();
24
+ const cacheKey = customInstructionsPath ?? stainlessApiKey ?? '';
25
+ const cached = instructionsCache.get(cacheKey);
26
+
27
+ if (cached && now - cached.fetchedAt <= INSTRUCTIONS_CACHE_TTL_MS) {
28
+ return cached.fetchedInstructions;
29
+ }
30
+
31
+ // Evict stale entries so the cache doesn't grow unboundedly.
18
32
  for (const [key, entry] of instructionsCache) {
19
33
  if (now - entry.fetchedAt > INSTRUCTIONS_CACHE_TTL_MS) {
20
34
  instructionsCache.delete(key);
21
35
  }
22
36
  }
23
- }, INSTRUCTIONS_CACHE_TTL_MS);
24
-
25
- // Don't keep the process alive just for cleanup.
26
- _cacheCleanupInterval.unref();
27
37
 
28
- export async function getInstructions(stainlessApiKey: string | undefined): Promise<string> {
29
- const cacheKey = stainlessApiKey ?? '';
30
- const cached = instructionsCache.get(cacheKey);
38
+ let fetchedInstructions: string;
31
39
 
32
- if (cached && Date.now() - cached.fetchedAt <= INSTRUCTIONS_CACHE_TTL_MS) {
33
- return cached.fetchedInstructions;
40
+ if (customInstructionsPath) {
41
+ fetchedInstructions = await fetchLatestInstructionsFromFile(customInstructionsPath);
42
+ } else {
43
+ fetchedInstructions = await fetchLatestInstructionsFromApi(stainlessApiKey);
34
44
  }
35
45
 
36
- const fetchedInstructions = await fetchLatestInstructions(stainlessApiKey);
37
- instructionsCache.set(cacheKey, { fetchedInstructions, fetchedAt: Date.now() });
46
+ instructionsCache.set(cacheKey, { fetchedInstructions, fetchedAt: now });
38
47
  return fetchedInstructions;
39
48
  }
40
49
 
41
- async function fetchLatestInstructions(stainlessApiKey: string | undefined): Promise<string> {
50
+ async function fetchLatestInstructionsFromFile(path: string): Promise<string> {
51
+ try {
52
+ return await fs.readFile(path, 'utf-8');
53
+ } catch (error) {
54
+ getLogger().error({ error, path }, 'Error fetching instructions from file');
55
+ throw error;
56
+ }
57
+ }
58
+
59
+ async function fetchLatestInstructionsFromApi(stainlessApiKey: string | undefined): Promise<string> {
42
60
  // Setting the stainless API key is optional, but may be required
43
61
  // to authenticate requests to the Stainless API.
44
62
  const response = await fetch(
@@ -55,21 +73,11 @@ async function fetchLatestInstructions(stainlessApiKey: string | undefined): Pro
55
73
  'Warning: failed to retrieve MCP server instructions. Proceeding with default instructions...',
56
74
  );
57
75
 
58
- instructions = `
59
- This is the llamacloud-prod MCP server. You will use Code Mode to help the user perform
60
- actions. You can use search_docs tool to learn about how to take action with this server. Then,
61
- you will write TypeScript code using the execute tool take action. It is CRITICAL that you be
62
- thoughtful and deliberate when executing code. Always try to entirely solve the problem in code
63
- block: it can be as long as you need to get the job done!
64
- `;
76
+ instructions =
77
+ '\n This is the llamacloud-prod MCP server.\n\n Available tools:\n - search_docs: Search SDK documentation to find the right methods and parameters.\n - execute: Run TypeScript code against a pre-authenticated SDK client. Define an async run(client) function.\n\n Workflow:\n - If unsure about the API, call search_docs first.\n - Write complete solutions in a single execute call when possible. For large datasets, use API filters to narrow results or paginate within a single execute block.\n - If execute returns an error, read the error and fix your code rather than retrying the same approach.\n - Variables do not persist between execute calls. Return or log all data you need.\n - Individual HTTP requests to the API have a 30-second timeout. If a request times out, try a smaller query or add filters.\n - Code execution has a total timeout of approximately 5 minutes. If your code times out, simplify it or break it into smaller steps.\n ';
65
78
  }
66
79
 
67
80
  instructions ??= ((await response.json()) as { instructions: string }).instructions;
68
- instructions = `
69
- If needed, you can get the current time by executing Date.now().
70
-
71
- ${instructions}
72
- `;
73
81
 
74
82
  return instructions;
75
83
  }