conductor-node-mcp 14.23.1 → 14.23.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/code-tool.d.mts.map +1 -1
- package/code-tool.d.ts.map +1 -1
- package/code-tool.js +82 -51
- package/code-tool.js.map +1 -1
- package/code-tool.mjs +84 -53
- package/code-tool.mjs.map +1 -1
- package/docs-search-tool.d.mts.map +1 -1
- package/docs-search-tool.d.ts.map +1 -1
- package/docs-search-tool.js +1 -41
- package/docs-search-tool.js.map +1 -1
- package/docs-search-tool.mjs +1 -41
- package/docs-search-tool.mjs.map +1 -1
- package/instructions.d.mts.map +1 -1
- package/instructions.d.ts.map +1 -1
- package/instructions.js +2 -18
- package/instructions.js.map +1 -1
- package/instructions.mjs +2 -18
- package/instructions.mjs.map +1 -1
- package/local-docs-search.js +4 -4
- package/local-docs-search.js.map +1 -1
- package/local-docs-search.mjs +4 -4
- package/local-docs-search.mjs.map +1 -1
- package/options.d.mts +2 -2
- package/options.d.mts.map +1 -1
- package/options.d.ts +2 -2
- package/options.d.ts.map +1 -1
- package/options.js +6 -6
- package/options.js.map +1 -1
- package/options.mjs +6 -6
- package/options.mjs.map +1 -1
- package/package.json +2 -3
- package/server.d.mts.map +1 -1
- package/server.d.ts.map +1 -1
- package/server.js +14 -4
- package/server.js.map +1 -1
- package/server.mjs +14 -4
- package/server.mjs.map +1 -1
- package/src/code-tool.ts +96 -77
- package/src/docs-search-tool.ts +2 -61
- package/src/instructions.ts +2 -28
- package/src/local-docs-search.ts +4 -4
- package/src/options.ts +9 -9
- package/src/server.ts +15 -4
package/src/docs-search-tool.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
import { Tool } from '@modelcontextprotocol/sdk/types.js';
|
|
4
4
|
import { Metadata, McpRequestContext, asTextContentResult } from './types';
|
|
5
|
-
|
|
5
|
+
|
|
6
6
|
import type { LocalDocsSearch } from './local-docs-search';
|
|
7
7
|
|
|
8
8
|
export const metadata: Metadata = {
|
|
@@ -41,9 +41,6 @@ export const tool: Tool = {
|
|
|
41
41
|
},
|
|
42
42
|
};
|
|
43
43
|
|
|
44
|
-
const docsSearchURL =
|
|
45
|
-
process.env['DOCS_SEARCH_URL'] || 'https://api.stainless.com/api/projects/conductor/docs/search';
|
|
46
|
-
|
|
47
44
|
let _localSearch: LocalDocsSearch | undefined;
|
|
48
45
|
|
|
49
46
|
export function setLocalSearch(search: LocalDocsSearch): void {
|
|
@@ -67,58 +64,6 @@ async function searchLocal(args: Record<string, unknown>): Promise<unknown> {
|
|
|
67
64
|
}).results;
|
|
68
65
|
}
|
|
69
66
|
|
|
70
|
-
async function searchRemote(args: Record<string, unknown>, reqContext: McpRequestContext): Promise<unknown> {
|
|
71
|
-
const body = args as any;
|
|
72
|
-
const query = new URLSearchParams(body).toString();
|
|
73
|
-
|
|
74
|
-
const startTime = Date.now();
|
|
75
|
-
const result = await fetch(`${docsSearchURL}?${query}`, {
|
|
76
|
-
headers: {
|
|
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
|
-
}),
|
|
82
|
-
},
|
|
83
|
-
});
|
|
84
|
-
|
|
85
|
-
const logger = getLogger();
|
|
86
|
-
|
|
87
|
-
if (!result.ok) {
|
|
88
|
-
const errorText = await result.text();
|
|
89
|
-
logger.warn(
|
|
90
|
-
{
|
|
91
|
-
durationMs: Date.now() - startTime,
|
|
92
|
-
query: body.query,
|
|
93
|
-
status: result.status,
|
|
94
|
-
statusText: result.statusText,
|
|
95
|
-
errorText,
|
|
96
|
-
},
|
|
97
|
-
'Got error response from docs search tool',
|
|
98
|
-
);
|
|
99
|
-
|
|
100
|
-
if (result.status === 404 && !reqContext.stainlessApiKey) {
|
|
101
|
-
throw new Error(
|
|
102
|
-
'Could not find docs for this project. You may need to provide a Stainless API key via the STAINLESS_API_KEY environment variable, the --stainless-api-key flag, or the x-stainless-api-key HTTP header.',
|
|
103
|
-
);
|
|
104
|
-
}
|
|
105
|
-
|
|
106
|
-
throw new Error(
|
|
107
|
-
`${result.status}: ${result.statusText} when using doc search tool. Details: ${errorText}`,
|
|
108
|
-
);
|
|
109
|
-
}
|
|
110
|
-
|
|
111
|
-
const resultBody = await result.json();
|
|
112
|
-
logger.info(
|
|
113
|
-
{
|
|
114
|
-
durationMs: Date.now() - startTime,
|
|
115
|
-
query: body.query,
|
|
116
|
-
},
|
|
117
|
-
'Got docs search result',
|
|
118
|
-
);
|
|
119
|
-
return resultBody;
|
|
120
|
-
}
|
|
121
|
-
|
|
122
67
|
export const handler = async ({
|
|
123
68
|
reqContext,
|
|
124
69
|
args,
|
|
@@ -128,11 +73,7 @@ export const handler = async ({
|
|
|
128
73
|
}) => {
|
|
129
74
|
const body = args ?? {};
|
|
130
75
|
|
|
131
|
-
|
|
132
|
-
return asTextContentResult(await searchLocal(body));
|
|
133
|
-
}
|
|
134
|
-
|
|
135
|
-
return asTextContentResult(await searchRemote(body, reqContext));
|
|
76
|
+
return asTextContentResult(await searchLocal(body));
|
|
136
77
|
};
|
|
137
78
|
|
|
138
79
|
export default { metadata, tool, handler };
|
package/src/instructions.ts
CHANGED
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
import fs from 'fs/promises';
|
|
4
4
|
import { getLogger } from './logger';
|
|
5
|
-
import { readEnv } from './util';
|
|
6
5
|
|
|
7
6
|
const INSTRUCTIONS_CACHE_TTL_MS = 15 * 60 * 1000; // 15 minutes
|
|
8
7
|
|
|
@@ -40,7 +39,8 @@ export async function getInstructions({
|
|
|
40
39
|
if (customInstructionsPath) {
|
|
41
40
|
fetchedInstructions = await fetchLatestInstructionsFromFile(customInstructionsPath);
|
|
42
41
|
} else {
|
|
43
|
-
fetchedInstructions =
|
|
42
|
+
fetchedInstructions =
|
|
43
|
+
'\n This is the conductor 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 ';
|
|
44
44
|
}
|
|
45
45
|
|
|
46
46
|
instructionsCache.set(cacheKey, { fetchedInstructions, fetchedAt: now });
|
|
@@ -55,29 +55,3 @@ async function fetchLatestInstructionsFromFile(path: string): Promise<string> {
|
|
|
55
55
|
throw error;
|
|
56
56
|
}
|
|
57
57
|
}
|
|
58
|
-
|
|
59
|
-
async function fetchLatestInstructionsFromApi(stainlessApiKey: string | undefined): Promise<string> {
|
|
60
|
-
// Setting the stainless API key is optional, but may be required
|
|
61
|
-
// to authenticate requests to the Stainless API.
|
|
62
|
-
const response = await fetch(
|
|
63
|
-
readEnv('CODE_MODE_INSTRUCTIONS_URL') ?? 'https://api.stainless.com/api/ai/instructions/conductor',
|
|
64
|
-
{
|
|
65
|
-
method: 'GET',
|
|
66
|
-
headers: { ...(stainlessApiKey && { Authorization: stainlessApiKey }) },
|
|
67
|
-
},
|
|
68
|
-
);
|
|
69
|
-
|
|
70
|
-
let instructions: string | undefined;
|
|
71
|
-
if (!response.ok) {
|
|
72
|
-
getLogger().warn(
|
|
73
|
-
'Warning: failed to retrieve MCP server instructions. Proceeding with default instructions...',
|
|
74
|
-
);
|
|
75
|
-
|
|
76
|
-
instructions =
|
|
77
|
-
'\n This is the conductor 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 ';
|
|
78
|
-
}
|
|
79
|
-
|
|
80
|
-
instructions ??= ((await response.json()) as { instructions: string }).instructions;
|
|
81
|
-
|
|
82
|
-
return instructions;
|
|
83
|
-
}
|
package/src/local-docs-search.ts
CHANGED
|
@@ -10757,14 +10757,14 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
10757
10757
|
|
|
10758
10758
|
const EMBEDDED_READMES: { language: string; content: string }[] = [
|
|
10759
10759
|
{
|
|
10760
|
-
language: '
|
|
10760
|
+
language: 'typescript',
|
|
10761
10761
|
content:
|
|
10762
|
-
'# QuickBooks Desktop Python API library\n\n<!-- prettier-ignore -->\n[)](https://pypi.org/project/conductor-py/)\n\nThe QuickBooks Desktop Python library provides convenient access to the Conductor REST API from any Python 3.9+\napplication. The library includes type definitions for all request params and response fields,\nand offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).\n\n\n\n\n\n## MCP Server\n\nUse the Conductor MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[](https://cursor.com/en-US/install-mcp?name=conductor-node-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsImNvbmR1Y3Rvci1ub2RlLW1jcCJdLCJlbnYiOnsiQ09ORFVDVE9SX1NFQ1JFVF9LRVkiOiJza19jb25kdWN0b3JfLi4uIn19)\n[](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22conductor-node-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22conductor-node-mcp%22%5D%2C%22env%22%3A%7B%22CONDUCTOR_SECRET_KEY%22%3A%22sk_conductor_...%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nThe REST API documentation can be found on [docs.conductor.is](https://docs.conductor.is/api-ref). The full API of this library can be found in [api.md](api.md).\n\n## Installation\n\n```sh\n# install from PyPI\npip install conductor-py\n```\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```python\nimport os\nfrom conductor import Conductor\n\nconductor = Conductor(\n api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted\n)\n\npage = conductor.qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n)\nprint(page.data)\n```\n\nWhile you can provide an `api_key` keyword argument,\nwe recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)\nto add `CONDUCTOR_SECRET_KEY="sk_conductor_..."` to your `.env` file\nso that your API Key is not stored in source control.\n\n## Async usage\n\nSimply import `AsyncConductor` instead of `Conductor` and use `await` with each API call:\n\n```python\nimport os\nimport asyncio\nfrom conductor import AsyncConductor\n\nconductor = AsyncConductor(\n api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted\n)\n\nasync def main() -> None:\n page = await conductor.qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n )\n print(page.data)\n\nasyncio.run(main())\n```\n\nFunctionality between the synchronous and asynchronous clients is otherwise identical.\n\n### With aiohttp\n\nBy default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.\n\nYou can enable this by installing `aiohttp`:\n\n```sh\n# install from PyPI\npip install conductor-py[aiohttp]\n```\n\nThen you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:\n\n```python\nimport os\nimport asyncio\nfrom conductor import DefaultAioHttpClient\nfrom conductor import AsyncConductor\n\nasync def main() -> None:\n async with AsyncConductor(\n api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted\n http_client=DefaultAioHttpClient(),\n) as conductor:\n page = await conductor.qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n )\n print(page.data)\n\nasyncio.run(main())\n```\n\n\n\n## Using types\n\nNested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:\n\n- Serializing back into JSON, `model.to_json()`\n- Converting to a dictionary, `model.to_dict()`\n\nTyped requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.\n\n## Pagination\n\nList methods in the Conductor API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```python\nfrom conductor import Conductor\n\nconductor = Conductor()\n\nall_invoices = []\n# Automatically fetches more pages as needed.\nfor invoice in conductor.qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n):\n # Do something with invoice here\n all_invoices.append(invoice)\nprint(all_invoices)\n```\n\nOr, asynchronously:\n\n```python\nimport asyncio\nfrom conductor import AsyncConductor\n\nconductor = AsyncConductor()\n\nasync def main() -> None:\n all_invoices = []\n # Iterate through items across all pages, issuing requests as needed.\n async for invoice in conductor.qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n):\n all_invoices.append(invoice)\n print(all_invoices)\n\nasyncio.run(main())\n```\n\nAlternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:\n\n```python\nfirst_page = await conductor.qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n)\nif first_page.has_next_page():\n print(f"will fetch next page using these details: {first_page.next_page_info()}")\n next_page = await first_page.get_next_page()\n print(f"number of items we just fetched: {len(next_page.data)}")\n\n# Remove `await` for non-async usage.\n```\n\nOr just work directly with the returned data:\n\n```python\nfirst_page = await conductor.qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n)\n\nprint(f"next page cursor: {first_page.next_cursor}") # => "next page cursor: ..."\nfor invoice in first_page.data:\n print(invoice.id)\n\n# Remove `await` for non-async usage.\n```\n\nfrom datetime import date\n\n## Nested params\n\nNested parameters are dictionaries, typed using `TypedDict`, for example:\n\n```python\nfrom conductor import Conductor\n\nconductor = Conductor()\n\nbill = conductor.qbd.bills.create(\n transaction_date=date.fromisoformat("2024-10-01"),\n vendor_id="80000001-1234567890",\n conductor_end_user_id="end_usr_1234567abcdefg",\n vendor_address={},\n)\nprint(bill.vendor_address)\n```\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `conductor.APIConnectionError` is raised.\n\nWhen the API returns a non-success status code (that is, 4xx or 5xx\nresponse), a subclass of `conductor.APIStatusError` is raised, containing `status_code` and `response` properties.\n\nAll errors inherit from `conductor.APIError`.\n\n```python\nimport conductor\nfrom conductor import Conductor\n\nconductor = Conductor()\n\ntry:\n conductor.qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n )\nexcept conductor.APIConnectionError as e:\n print("The server could not be reached")\n print(e.__cause__) # an underlying Exception, likely raised within httpx.\nexcept conductor.RateLimitError as e:\n print("A 429 status code was received; we should back off a bit.")\nexcept conductor.APIStatusError as e:\n print("Another non-200-range status code was received")\n print(e.status_code)\n print(e.response)\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors are automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors are all retried by default.\n\nYou can use the `max_retries` option to configure or disable retry settings:\n\n```python\nfrom conductor import Conductor\n\n# Configure the default for all requests:\nconductor = Conductor(\n # default is 2\n max_retries=0,\n)\n\n# Or, configure per-request:\nconductor.with_options(max_retries = 5).qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n)\n```\n\n### Timeouts\n\nBy default requests time out after 2 minutes. You can configure this with a `timeout` option,\nwhich accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:\n\n```python\nfrom conductor import Conductor\n\n# Configure the default for all requests:\nconductor = Conductor(\n # 20 seconds (default is 2 minutes)\n timeout=20.0,\n)\n\n# More granular control:\nconductor = Conductor(\n timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),\n)\n\n# Override per-request:\nconductor.with_options(timeout = 5.0).qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n)\n```\n\nOn timeout, an `APITimeoutError` is thrown.\n\nNote that requests that time out are [retried twice by default](#retries).\n\n\n\n## Advanced\n\n### Logging\n\nWe use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.\n\nYou can enable logging by setting the environment variable `CONDUCTOR_LOG` to `info`.\n\n```shell\n$ export CONDUCTOR_LOG=info\n```\n\nOr to `debug` for more verbose logging.\n\n### How to tell whether `None` means `null` or missing\n\nIn an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:\n\n```py\nif response.my_field is None:\n if \'my_field\' not in response.model_fields_set:\n print(\'Got json like {}, without a "my_field" key present at all.\')\n else:\n print(\'Got json like {"my_field": null}.\')\n```\n\n### Accessing raw response data (e.g. headers)\n\nThe "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,\n\n```py\nfrom conductor import Conductor\n\nconductor = Conductor()\nresponse = conductor.qbd.invoices.with_raw_response.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n)\nprint(response.headers.get(\'X-My-Header\'))\n\ninvoice = response.parse() # get the object that `qbd.invoices.list()` would have returned\nprint(invoice.id)\n```\n\nThese methods return an [`APIResponse`](https://github.com/conductor-is/quickbooks-desktop-python/tree/main/src/conductor/_response.py) object.\n\nThe async client returns an [`AsyncAPIResponse`](https://github.com/conductor-is/quickbooks-desktop-python/tree/main/src/conductor/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.\n\n#### `.with_streaming_response`\n\nThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.\n\nTo stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.\n\n```python\nwith conductor.qbd.invoices.with_streaming_response.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n) as response :\n print(response.headers.get(\'X-My-Header\'))\n\n for line in response.iter_lines():\n print(line)\n```\n\nThe context manager is required so that the response will reliably be closed.\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API.\n\nIf you need to access undocumented endpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can make requests using `conductor.get`, `conductor.post`, and other\nhttp verbs. Options on the client will be respected (such as retries) when making this request.\n\n```py\nimport httpx\n\nresponse = conductor.post(\n "/foo",\n cast_to=httpx.Response,\n body={"my_param": True},\n)\n\nprint(response.headers.get("x-foo"))\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You\ncan also get all the extra fields on the Pydantic model as a dict with\n[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).\n\n### Configuring the HTTP client\n\nYou can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:\n\n- Support for [proxies](https://www.python-httpx.org/advanced/proxies/)\n- Custom [transports](https://www.python-httpx.org/advanced/transports/)\n- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality\n\n```python\nimport httpx\nfrom conductor import Conductor, DefaultHttpxClient\n\nconductor = Conductor(\n # Or use the `CONDUCTOR_BASE_URL` env var\n base_url="http://my.test.server.example.com:8083",\n http_client=DefaultHttpxClient(proxy="http://my.test.proxy.example.com", transport=httpx.HTTPTransport(local_address="0.0.0.0")),\n)\n```\n\nYou can also customize the client on a per-request basis by using `with_options()`:\n\n```python\nconductor.with_options(http_client=DefaultHttpxClient(...))\n```\n\n### Managing HTTP resources\n\nBy default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.\n\n```py\nfrom conductor import Conductor\n\nwith Conductor() as conductor:\n # make requests here\n ...\n\n# HTTP client is now closed\n```\n\n## Versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/conductor-is/quickbooks-desktop-python/issues) with questions, bugs, or suggestions.\n\n### Determining the installed version\n\nIf you\'ve upgraded to the latest version but aren\'t seeing any new features you were expecting then your python environment is likely still using an older version.\n\nYou can determine the version that is being used at runtime with:\n\n```py\nimport conductor\nprint(conductor.__version__)\n```\n\n## Requirements\n\nPython 3.9 or higher.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n',
|
|
10762
|
+
"# QuickBooks Desktop Node.js API Library\n\n[)](https://npmjs.org/package/conductor-node) \n\nThis library provides convenient access to the Conductor REST API from server-side TypeScript or JavaScript.\n\n\n\nThe REST API documentation can be found on [docs.conductor.is](https://docs.conductor.is/api-ref). The full API of this library can be found in [api.md](api.md).\n\n\n\n## MCP Server\n\nUse the Conductor MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[](https://cursor.com/en-US/install-mcp?name=conductor-node-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsImNvbmR1Y3Rvci1ub2RlLW1jcCJdLCJlbnYiOnsiQ09ORFVDVE9SX1NFQ1JFVF9LRVkiOiJza19jb25kdWN0b3JfLi4uIn19)\n[](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22conductor-node-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22conductor-node-mcp%22%5D%2C%22env%22%3A%7B%22CONDUCTOR_SECRET_KEY%22%3A%22sk_conductor_...%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n```sh\nnpm install conductor-node\n```\n\n\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n<!-- prettier-ignore -->\n```js\nimport Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted\n});\n\nconst page = await conductor.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' });\nconst invoice = page.data[0];\n\nconsole.log(invoice.id);\n```\n\n\n\n### Request & Response types\n\nThis library includes TypeScript definitions for all request params and response fields. You may import and use them like so:\n\n<!-- prettier-ignore -->\n```ts\nimport Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted\n});\n\nconst params: Conductor.Qbd.InvoiceListParams = { conductorEndUserId: 'YOUR_END_USER_ID' };\nconst [invoice]: [Conductor.Qbd.Invoice] = await conductor.qbd.invoices.list(params);\n```\n\nDocumentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.\n\n\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API,\nor if the API returns a non-success status code (i.e., 4xx or 5xx response),\na subclass of `APIError` will be thrown:\n\n<!-- prettier-ignore -->\n```ts\nconst page = await conductor.qbd.invoices\n .list({ conductorEndUserId: 'YOUR_END_USER_ID' })\n .catch(async (err) => {\n if (err instanceof Conductor.APIError) {\n console.log(err.status); // 400\n console.log(err.name); // BadRequestError\n console.log(err.headers); // {server: 'nginx', ...}\n } else {\n throw err;\n }\n });\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors will all be retried by default.\n\nYou can use the `maxRetries` option to configure or disable this:\n\n<!-- prettier-ignore -->\n```js\n// Configure the default for all requests:\nconst conductor = new Conductor({\n maxRetries: 0, // default is 2\n});\n\n// Or, configure per-request:\nawait conductor.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' }, {\n maxRetries: 5,\n});\n```\n\n### Timeouts\n\nRequests time out after 2 minutes by default. You can configure this with a `timeout` option:\n\n<!-- prettier-ignore -->\n```ts\n// Configure the default for all requests:\nconst conductor = new Conductor({\n timeout: 20 * 1000, // 20 seconds (default is 2 minutes)\n});\n\n// Override per-request:\nawait conductor.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' }, {\n timeout: 5 * 1000,\n});\n```\n\nOn timeout, an `APIConnectionTimeoutError` is thrown.\n\nNote that requests which time out will be [retried twice by default](#retries).\n\n## Auto-pagination\n\nList methods in the Conductor API are paginated.\nYou can use the `for await … of` syntax to iterate through items across all pages:\n\n```ts\nasync function fetchAllInvoices(params) {\n const allInvoices = [];\n // Automatically fetches more pages as needed.\n for await (const invoice of conductor.qbd.invoices.list({\n conductorEndUserId: 'YOUR_END_USER_ID',\n })) {\n allInvoices.push(invoice);\n }\n return allInvoices;\n}\n```\n\nAlternatively, you can request a single page at a time:\n\n```ts\nlet page = await conductor.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' });\nfor (const invoice of page.data) {\n console.log(invoice);\n}\n\n// Convenience methods are provided for manually paginating:\nwhile (page.hasNextPage()) {\n page = await page.getNextPage();\n // ...\n}\n```\n\n\n\n## Advanced Usage\n\n### Accessing raw Response data (e.g., headers)\n\nThe \"raw\" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.\nThis method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.\n\nYou can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.\nUnlike `.asResponse()` this method consumes the body, returning once it is parsed.\n\n<!-- prettier-ignore -->\n```ts\nconst conductor = new Conductor();\n\nconst response = await conductor.qbd.invoices\n .list({ conductorEndUserId: 'YOUR_END_USER_ID' })\n .asResponse();\nconsole.log(response.headers.get('X-My-Header'));\nconsole.log(response.statusText); // access the underlying Response object\n\nconst { data: page, response: raw } = await conductor.qbd.invoices\n .list({ conductorEndUserId: 'YOUR_END_USER_ID' })\n .withResponse();\nconsole.log(raw.headers.get('X-My-Header'));\nfor await (const invoice of page) {\n console.log(invoice.id);\n}\n```\n\n### Logging\n\n> [!IMPORTANT]\n> All log messages are intended for debugging only. The format and content of log messages\n> may change between releases.\n\n#### Log levels\n\nThe log level can be configured in two ways:\n\n1. Via the `CONDUCTOR_LOG` environment variable\n2. Using the `logLevel` client option (overrides the environment variable if set)\n\n```ts\nimport Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n logLevel: 'debug', // Show all log messages\n});\n```\n\nAvailable log levels, from most to least verbose:\n\n- `'debug'` - Show debug messages, info, warnings, and errors\n- `'info'` - Show info messages, warnings, and errors\n- `'warn'` - Show warnings and errors (default)\n- `'error'` - Show only errors\n- `'off'` - Disable all logging\n\nAt the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.\nSome authentication-related headers are redacted, but sensitive data in request and response bodies\nmay still be visible.\n\n#### Custom logger\n\nBy default, this library logs to `globalThis.console`. You can also provide a custom logger.\nMost logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.\n\nWhen providing a custom logger, the `logLevel` option still controls which messages are emitted, messages\nbelow the configured level will not be sent to your logger.\n\n```ts\nimport Conductor from 'conductor-node';\nimport pino from 'pino';\n\nconst logger = pino();\n\nconst conductor = new Conductor({\n logger: logger.child({ name: 'Conductor' }),\n logLevel: 'debug', // Send all messages to pino, allowing it to filter\n});\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `conductor.get`, `conductor.post`, and other HTTP verbs.\nOptions on the client, such as retries, will be respected when making these requests.\n\n```ts\nawait conductor.post('/some/path', {\n body: { some_prop: 'foo' },\n query: { some_query_arg: 'bar' },\n});\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented\nparameter. This library doesn't validate at runtime that the request matches the type, so any extra values you\nsend will be sent as-is.\n\n```ts\nconductor.qbd.invoices.list({\n // ...\n // @ts-expect-error baz is not yet public\n baz: 'undocumented option',\n});\n```\n\nFor requests with the `GET` verb, any extra params will be in the query, all other requests will send the\nextra param in the body.\n\nIf you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may access the response object with `// @ts-expect-error` on\nthe response object, or cast the response object to the requisite type. Like the request params, we do not\nvalidate or strip extra properties from the response from the API.\n\n### Customizing the fetch client\n\nBy default, this library expects a global `fetch` function is defined.\n\nIf you want to use a different `fetch` function, you can either polyfill the global:\n\n```ts\nimport fetch from 'my-fetch';\n\nglobalThis.fetch = fetch;\n```\n\nOr pass it to the client:\n\n```ts\nimport Conductor from 'conductor-node';\nimport fetch from 'my-fetch';\n\nconst conductor = new Conductor({ fetch });\n```\n\n### Fetch options\n\nIf you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)\n\n```ts\nimport Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n fetchOptions: {\n // `RequestInit` options\n },\n});\n```\n\n#### Configuring proxies\n\nTo modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy\noptions to requests:\n\n<img src=\"https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/node.svg\" align=\"top\" width=\"18\" height=\"21\"> **Node** <sup>[[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]</sup>\n\n```ts\nimport Conductor from 'conductor-node';\nimport * as undici from 'undici';\n\nconst proxyAgent = new undici.ProxyAgent('http://localhost:8888');\nconst conductor = new Conductor({\n fetchOptions: {\n dispatcher: proxyAgent,\n },\n});\n```\n\n<img src=\"https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/bun.svg\" align=\"top\" width=\"18\" height=\"21\"> **Bun** <sup>[[docs](https://bun.sh/guides/http/proxy)]</sup>\n\n```ts\nimport Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n fetchOptions: {\n proxy: 'http://localhost:8888',\n },\n});\n```\n\n<img src=\"https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/deno.svg\" align=\"top\" width=\"18\" height=\"21\"> **Deno** <sup>[[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]</sup>\n\n```ts\nimport Conductor from 'npm:conductor-node';\n\nconst httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });\nconst conductor = new Conductor({\n fetchOptions: {\n client: httpClient,\n },\n});\n```\n\n## Frequently Asked Questions\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/conductor-is/quickbooks-desktop-node/issues) with questions, bugs, or suggestions.\n\n## Requirements\n\nTypeScript >= 4.9 is supported.\n\nThe following runtimes are supported:\n\n- Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)\n- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.\n- Deno v1.28.0 or higher.\n- Bun 1.0 or later.\n- Cloudflare Workers.\n- Vercel Edge Runtime.\n- Jest 28 or greater with the `\"node\"` environment (`\"jsdom\"` is not supported at this time).\n- Nitro v2.6 or greater.\n\nNote that React Native is not supported at this time.\n\nIf you are interested in other runtime environments, please open or upvote an issue on GitHub.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n",
|
|
10763
10763
|
},
|
|
10764
10764
|
{
|
|
10765
|
-
language: '
|
|
10765
|
+
language: 'python',
|
|
10766
10766
|
content:
|
|
10767
|
-
"# QuickBooks Desktop Node.js API Library\n\n[)](https://npmjs.org/package/conductor-node) \n\nThis library provides convenient access to the Conductor REST API from server-side TypeScript or JavaScript.\n\n\n\nThe REST API documentation can be found on [docs.conductor.is](https://docs.conductor.is/api-ref). The full API of this library can be found in [api.md](api.md).\n\n\n\n## MCP Server\n\nUse the Conductor MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[](https://cursor.com/en-US/install-mcp?name=conductor-node-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsImNvbmR1Y3Rvci1ub2RlLW1jcCJdLCJlbnYiOnsiQ09ORFVDVE9SX1NFQ1JFVF9LRVkiOiJza19jb25kdWN0b3JfLi4uIn19)\n[](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22conductor-node-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22conductor-node-mcp%22%5D%2C%22env%22%3A%7B%22CONDUCTOR_SECRET_KEY%22%3A%22sk_conductor_...%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n```sh\nnpm install conductor-node\n```\n\n\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n<!-- prettier-ignore -->\n```js\nimport Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted\n});\n\nconst page = await conductor.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' });\nconst invoice = page.data[0];\n\nconsole.log(invoice.id);\n```\n\n\n\n### Request & Response types\n\nThis library includes TypeScript definitions for all request params and response fields. You may import and use them like so:\n\n<!-- prettier-ignore -->\n```ts\nimport Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted\n});\n\nconst params: Conductor.Qbd.InvoiceListParams = { conductorEndUserId: 'YOUR_END_USER_ID' };\nconst [invoice]: [Conductor.Qbd.Invoice] = await conductor.qbd.invoices.list(params);\n```\n\nDocumentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.\n\n\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API,\nor if the API returns a non-success status code (i.e., 4xx or 5xx response),\na subclass of `APIError` will be thrown:\n\n<!-- prettier-ignore -->\n```ts\nconst page = await conductor.qbd.invoices\n .list({ conductorEndUserId: 'YOUR_END_USER_ID' })\n .catch(async (err) => {\n if (err instanceof Conductor.APIError) {\n console.log(err.status); // 400\n console.log(err.name); // BadRequestError\n console.log(err.headers); // {server: 'nginx', ...}\n } else {\n throw err;\n }\n });\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors will all be retried by default.\n\nYou can use the `maxRetries` option to configure or disable this:\n\n<!-- prettier-ignore -->\n```js\n// Configure the default for all requests:\nconst conductor = new Conductor({\n maxRetries: 0, // default is 2\n});\n\n// Or, configure per-request:\nawait conductor.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' }, {\n maxRetries: 5,\n});\n```\n\n### Timeouts\n\nRequests time out after 2 minutes by default. You can configure this with a `timeout` option:\n\n<!-- prettier-ignore -->\n```ts\n// Configure the default for all requests:\nconst conductor = new Conductor({\n timeout: 20 * 1000, // 20 seconds (default is 2 minutes)\n});\n\n// Override per-request:\nawait conductor.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' }, {\n timeout: 5 * 1000,\n});\n```\n\nOn timeout, an `APIConnectionTimeoutError` is thrown.\n\nNote that requests which time out will be [retried twice by default](#retries).\n\n## Auto-pagination\n\nList methods in the Conductor API are paginated.\nYou can use the `for await … of` syntax to iterate through items across all pages:\n\n```ts\nasync function fetchAllInvoices(params) {\n const allInvoices = [];\n // Automatically fetches more pages as needed.\n for await (const invoice of conductor.qbd.invoices.list({\n conductorEndUserId: 'YOUR_END_USER_ID',\n })) {\n allInvoices.push(invoice);\n }\n return allInvoices;\n}\n```\n\nAlternatively, you can request a single page at a time:\n\n```ts\nlet page = await conductor.qbd.invoices.list({ conductorEndUserId: 'YOUR_END_USER_ID' });\nfor (const invoice of page.data) {\n console.log(invoice);\n}\n\n// Convenience methods are provided for manually paginating:\nwhile (page.hasNextPage()) {\n page = await page.getNextPage();\n // ...\n}\n```\n\n\n\n## Advanced Usage\n\n### Accessing raw Response data (e.g., headers)\n\nThe \"raw\" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.\nThis method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.\n\nYou can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.\nUnlike `.asResponse()` this method consumes the body, returning once it is parsed.\n\n<!-- prettier-ignore -->\n```ts\nconst conductor = new Conductor();\n\nconst response = await conductor.qbd.invoices\n .list({ conductorEndUserId: 'YOUR_END_USER_ID' })\n .asResponse();\nconsole.log(response.headers.get('X-My-Header'));\nconsole.log(response.statusText); // access the underlying Response object\n\nconst { data: page, response: raw } = await conductor.qbd.invoices\n .list({ conductorEndUserId: 'YOUR_END_USER_ID' })\n .withResponse();\nconsole.log(raw.headers.get('X-My-Header'));\nfor await (const invoice of page) {\n console.log(invoice.id);\n}\n```\n\n### Logging\n\n> [!IMPORTANT]\n> All log messages are intended for debugging only. The format and content of log messages\n> may change between releases.\n\n#### Log levels\n\nThe log level can be configured in two ways:\n\n1. Via the `CONDUCTOR_LOG` environment variable\n2. Using the `logLevel` client option (overrides the environment variable if set)\n\n```ts\nimport Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n logLevel: 'debug', // Show all log messages\n});\n```\n\nAvailable log levels, from most to least verbose:\n\n- `'debug'` - Show debug messages, info, warnings, and errors\n- `'info'` - Show info messages, warnings, and errors\n- `'warn'` - Show warnings and errors (default)\n- `'error'` - Show only errors\n- `'off'` - Disable all logging\n\nAt the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.\nSome authentication-related headers are redacted, but sensitive data in request and response bodies\nmay still be visible.\n\n#### Custom logger\n\nBy default, this library logs to `globalThis.console`. You can also provide a custom logger.\nMost logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.\n\nWhen providing a custom logger, the `logLevel` option still controls which messages are emitted, messages\nbelow the configured level will not be sent to your logger.\n\n```ts\nimport Conductor from 'conductor-node';\nimport pino from 'pino';\n\nconst logger = pino();\n\nconst conductor = new Conductor({\n logger: logger.child({ name: 'Conductor' }),\n logLevel: 'debug', // Send all messages to pino, allowing it to filter\n});\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `conductor.get`, `conductor.post`, and other HTTP verbs.\nOptions on the client, such as retries, will be respected when making these requests.\n\n```ts\nawait conductor.post('/some/path', {\n body: { some_prop: 'foo' },\n query: { some_query_arg: 'bar' },\n});\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented\nparameter. This library doesn't validate at runtime that the request matches the type, so any extra values you\nsend will be sent as-is.\n\n```ts\nconductor.qbd.invoices.list({\n // ...\n // @ts-expect-error baz is not yet public\n baz: 'undocumented option',\n});\n```\n\nFor requests with the `GET` verb, any extra params will be in the query, all other requests will send the\nextra param in the body.\n\nIf you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may access the response object with `// @ts-expect-error` on\nthe response object, or cast the response object to the requisite type. Like the request params, we do not\nvalidate or strip extra properties from the response from the API.\n\n### Customizing the fetch client\n\nBy default, this library expects a global `fetch` function is defined.\n\nIf you want to use a different `fetch` function, you can either polyfill the global:\n\n```ts\nimport fetch from 'my-fetch';\n\nglobalThis.fetch = fetch;\n```\n\nOr pass it to the client:\n\n```ts\nimport Conductor from 'conductor-node';\nimport fetch from 'my-fetch';\n\nconst conductor = new Conductor({ fetch });\n```\n\n### Fetch options\n\nIf you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)\n\n```ts\nimport Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n fetchOptions: {\n // `RequestInit` options\n },\n});\n```\n\n#### Configuring proxies\n\nTo modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy\noptions to requests:\n\n<img src=\"https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/node.svg\" align=\"top\" width=\"18\" height=\"21\"> **Node** <sup>[[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]</sup>\n\n```ts\nimport Conductor from 'conductor-node';\nimport * as undici from 'undici';\n\nconst proxyAgent = new undici.ProxyAgent('http://localhost:8888');\nconst conductor = new Conductor({\n fetchOptions: {\n dispatcher: proxyAgent,\n },\n});\n```\n\n<img src=\"https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/bun.svg\" align=\"top\" width=\"18\" height=\"21\"> **Bun** <sup>[[docs](https://bun.sh/guides/http/proxy)]</sup>\n\n```ts\nimport Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n fetchOptions: {\n proxy: 'http://localhost:8888',\n },\n});\n```\n\n<img src=\"https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/deno.svg\" align=\"top\" width=\"18\" height=\"21\"> **Deno** <sup>[[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]</sup>\n\n```ts\nimport Conductor from 'npm:conductor-node';\n\nconst httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });\nconst conductor = new Conductor({\n fetchOptions: {\n client: httpClient,\n },\n});\n```\n\n## Frequently Asked Questions\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/conductor-is/quickbooks-desktop-node/issues) with questions, bugs, or suggestions.\n\n## Requirements\n\nTypeScript >= 4.9 is supported.\n\nThe following runtimes are supported:\n\n- Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)\n- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.\n- Deno v1.28.0 or higher.\n- Bun 1.0 or later.\n- Cloudflare Workers.\n- Vercel Edge Runtime.\n- Jest 28 or greater with the `\"node\"` environment (`\"jsdom\"` is not supported at this time).\n- Nitro v2.6 or greater.\n\nNote that React Native is not supported at this time.\n\nIf you are interested in other runtime environments, please open or upvote an issue on GitHub.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n",
|
|
10767
|
+
'# QuickBooks Desktop Python API library\n\n<!-- prettier-ignore -->\n[)](https://pypi.org/project/conductor-py/)\n\nThe QuickBooks Desktop Python library provides convenient access to the Conductor REST API from any Python 3.9+\napplication. The library includes type definitions for all request params and response fields,\nand offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).\n\n\n\n\n\n## MCP Server\n\nUse the Conductor MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[](https://cursor.com/en-US/install-mcp?name=conductor-node-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsImNvbmR1Y3Rvci1ub2RlLW1jcCJdLCJlbnYiOnsiQ09ORFVDVE9SX1NFQ1JFVF9LRVkiOiJza19jb25kdWN0b3JfLi4uIn19)\n[](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22conductor-node-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22conductor-node-mcp%22%5D%2C%22env%22%3A%7B%22CONDUCTOR_SECRET_KEY%22%3A%22sk_conductor_...%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nThe REST API documentation can be found on [docs.conductor.is](https://docs.conductor.is/api-ref). The full API of this library can be found in [api.md](api.md).\n\n## Installation\n\n```sh\n# install from PyPI\npip install conductor-py\n```\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```python\nimport os\nfrom conductor import Conductor\n\nconductor = Conductor(\n api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted\n)\n\npage = conductor.qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n)\nprint(page.data)\n```\n\nWhile you can provide an `api_key` keyword argument,\nwe recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)\nto add `CONDUCTOR_SECRET_KEY="sk_conductor_..."` to your `.env` file\nso that your API Key is not stored in source control.\n\n## Async usage\n\nSimply import `AsyncConductor` instead of `Conductor` and use `await` with each API call:\n\n```python\nimport os\nimport asyncio\nfrom conductor import AsyncConductor\n\nconductor = AsyncConductor(\n api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted\n)\n\nasync def main() -> None:\n page = await conductor.qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n )\n print(page.data)\n\nasyncio.run(main())\n```\n\nFunctionality between the synchronous and asynchronous clients is otherwise identical.\n\n### With aiohttp\n\nBy default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.\n\nYou can enable this by installing `aiohttp`:\n\n```sh\n# install from PyPI\npip install conductor-py[aiohttp]\n```\n\nThen you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:\n\n```python\nimport os\nimport asyncio\nfrom conductor import DefaultAioHttpClient\nfrom conductor import AsyncConductor\n\nasync def main() -> None:\n async with AsyncConductor(\n api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted\n http_client=DefaultAioHttpClient(),\n) as conductor:\n page = await conductor.qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n )\n print(page.data)\n\nasyncio.run(main())\n```\n\n\n\n## Using types\n\nNested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:\n\n- Serializing back into JSON, `model.to_json()`\n- Converting to a dictionary, `model.to_dict()`\n\nTyped requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.\n\n## Pagination\n\nList methods in the Conductor API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```python\nfrom conductor import Conductor\n\nconductor = Conductor()\n\nall_invoices = []\n# Automatically fetches more pages as needed.\nfor invoice in conductor.qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n):\n # Do something with invoice here\n all_invoices.append(invoice)\nprint(all_invoices)\n```\n\nOr, asynchronously:\n\n```python\nimport asyncio\nfrom conductor import AsyncConductor\n\nconductor = AsyncConductor()\n\nasync def main() -> None:\n all_invoices = []\n # Iterate through items across all pages, issuing requests as needed.\n async for invoice in conductor.qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n):\n all_invoices.append(invoice)\n print(all_invoices)\n\nasyncio.run(main())\n```\n\nAlternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:\n\n```python\nfirst_page = await conductor.qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n)\nif first_page.has_next_page():\n print(f"will fetch next page using these details: {first_page.next_page_info()}")\n next_page = await first_page.get_next_page()\n print(f"number of items we just fetched: {len(next_page.data)}")\n\n# Remove `await` for non-async usage.\n```\n\nOr just work directly with the returned data:\n\n```python\nfirst_page = await conductor.qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n)\n\nprint(f"next page cursor: {first_page.next_cursor}") # => "next page cursor: ..."\nfor invoice in first_page.data:\n print(invoice.id)\n\n# Remove `await` for non-async usage.\n```\n\nfrom datetime import date\n\n## Nested params\n\nNested parameters are dictionaries, typed using `TypedDict`, for example:\n\n```python\nfrom conductor import Conductor\n\nconductor = Conductor()\n\nbill = conductor.qbd.bills.create(\n transaction_date=date.fromisoformat("2024-10-01"),\n vendor_id="80000001-1234567890",\n conductor_end_user_id="end_usr_1234567abcdefg",\n vendor_address={},\n)\nprint(bill.vendor_address)\n```\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `conductor.APIConnectionError` is raised.\n\nWhen the API returns a non-success status code (that is, 4xx or 5xx\nresponse), a subclass of `conductor.APIStatusError` is raised, containing `status_code` and `response` properties.\n\nAll errors inherit from `conductor.APIError`.\n\n```python\nimport conductor\nfrom conductor import Conductor\n\nconductor = Conductor()\n\ntry:\n conductor.qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n )\nexcept conductor.APIConnectionError as e:\n print("The server could not be reached")\n print(e.__cause__) # an underlying Exception, likely raised within httpx.\nexcept conductor.RateLimitError as e:\n print("A 429 status code was received; we should back off a bit.")\nexcept conductor.APIStatusError as e:\n print("Another non-200-range status code was received")\n print(e.status_code)\n print(e.response)\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors are automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors are all retried by default.\n\nYou can use the `max_retries` option to configure or disable retry settings:\n\n```python\nfrom conductor import Conductor\n\n# Configure the default for all requests:\nconductor = Conductor(\n # default is 2\n max_retries=0,\n)\n\n# Or, configure per-request:\nconductor.with_options(max_retries = 5).qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n)\n```\n\n### Timeouts\n\nBy default requests time out after 2 minutes. You can configure this with a `timeout` option,\nwhich accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:\n\n```python\nfrom conductor import Conductor\n\n# Configure the default for all requests:\nconductor = Conductor(\n # 20 seconds (default is 2 minutes)\n timeout=20.0,\n)\n\n# More granular control:\nconductor = Conductor(\n timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),\n)\n\n# Override per-request:\nconductor.with_options(timeout = 5.0).qbd.invoices.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n)\n```\n\nOn timeout, an `APITimeoutError` is thrown.\n\nNote that requests that time out are [retried twice by default](#retries).\n\n\n\n## Advanced\n\n### Logging\n\nWe use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.\n\nYou can enable logging by setting the environment variable `CONDUCTOR_LOG` to `info`.\n\n```shell\n$ export CONDUCTOR_LOG=info\n```\n\nOr to `debug` for more verbose logging.\n\n### How to tell whether `None` means `null` or missing\n\nIn an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:\n\n```py\nif response.my_field is None:\n if \'my_field\' not in response.model_fields_set:\n print(\'Got json like {}, without a "my_field" key present at all.\')\n else:\n print(\'Got json like {"my_field": null}.\')\n```\n\n### Accessing raw response data (e.g. headers)\n\nThe "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,\n\n```py\nfrom conductor import Conductor\n\nconductor = Conductor()\nresponse = conductor.qbd.invoices.with_raw_response.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n)\nprint(response.headers.get(\'X-My-Header\'))\n\ninvoice = response.parse() # get the object that `qbd.invoices.list()` would have returned\nprint(invoice.id)\n```\n\nThese methods return an [`APIResponse`](https://github.com/conductor-is/quickbooks-desktop-python/tree/main/src/conductor/_response.py) object.\n\nThe async client returns an [`AsyncAPIResponse`](https://github.com/conductor-is/quickbooks-desktop-python/tree/main/src/conductor/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.\n\n#### `.with_streaming_response`\n\nThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.\n\nTo stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.\n\n```python\nwith conductor.qbd.invoices.with_streaming_response.list(\n conductor_end_user_id="YOUR_END_USER_ID",\n) as response :\n print(response.headers.get(\'X-My-Header\'))\n\n for line in response.iter_lines():\n print(line)\n```\n\nThe context manager is required so that the response will reliably be closed.\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API.\n\nIf you need to access undocumented endpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can make requests using `conductor.get`, `conductor.post`, and other\nhttp verbs. Options on the client will be respected (such as retries) when making this request.\n\n```py\nimport httpx\n\nresponse = conductor.post(\n "/foo",\n cast_to=httpx.Response,\n body={"my_param": True},\n)\n\nprint(response.headers.get("x-foo"))\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You\ncan also get all the extra fields on the Pydantic model as a dict with\n[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).\n\n### Configuring the HTTP client\n\nYou can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:\n\n- Support for [proxies](https://www.python-httpx.org/advanced/proxies/)\n- Custom [transports](https://www.python-httpx.org/advanced/transports/)\n- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality\n\n```python\nimport httpx\nfrom conductor import Conductor, DefaultHttpxClient\n\nconductor = Conductor(\n # Or use the `CONDUCTOR_BASE_URL` env var\n base_url="http://my.test.server.example.com:8083",\n http_client=DefaultHttpxClient(proxy="http://my.test.proxy.example.com", transport=httpx.HTTPTransport(local_address="0.0.0.0")),\n)\n```\n\nYou can also customize the client on a per-request basis by using `with_options()`:\n\n```python\nconductor.with_options(http_client=DefaultHttpxClient(...))\n```\n\n### Managing HTTP resources\n\nBy default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.\n\n```py\nfrom conductor import Conductor\n\nwith Conductor() as conductor:\n # make requests here\n ...\n\n# HTTP client is now closed\n```\n\n## Versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/conductor-is/quickbooks-desktop-python/issues) with questions, bugs, or suggestions.\n\n### Determining the installed version\n\nIf you\'ve upgraded to the latest version but aren\'t seeing any new features you were expecting then your python environment is likely still using an older version.\n\nYou can determine the version that is being used at runtime with:\n\n```py\nimport conductor\nprint(conductor.__version__)\n```\n\n## Requirements\n\nPython 3.9 or higher.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n',
|
|
10768
10768
|
},
|
|
10769
10769
|
];
|
|
10770
10770
|
|
package/src/options.ts
CHANGED
|
@@ -18,7 +18,7 @@ export type McpOptions = {
|
|
|
18
18
|
includeCodeTool?: boolean | undefined;
|
|
19
19
|
includeDocsTools?: boolean | undefined;
|
|
20
20
|
stainlessApiKey?: string | undefined;
|
|
21
|
-
docsSearchMode?: '
|
|
21
|
+
docsSearchMode?: 'local' | undefined;
|
|
22
22
|
docsDir?: string | undefined;
|
|
23
23
|
codeAllowHttpGets?: boolean | undefined;
|
|
24
24
|
codeAllowedMethods?: string[] | undefined;
|
|
@@ -27,7 +27,7 @@ export type McpOptions = {
|
|
|
27
27
|
customInstructionsPath?: string | undefined;
|
|
28
28
|
};
|
|
29
29
|
|
|
30
|
-
export type McpCodeExecutionMode = '
|
|
30
|
+
export type McpCodeExecutionMode = 'local';
|
|
31
31
|
|
|
32
32
|
export function parseCLIOptions(): CLIOptions {
|
|
33
33
|
const opts = yargs(hideBin(process.argv))
|
|
@@ -50,10 +50,10 @@ export function parseCLIOptions(): CLIOptions {
|
|
|
50
50
|
})
|
|
51
51
|
.option('code-execution-mode', {
|
|
52
52
|
type: 'string',
|
|
53
|
-
choices: ['
|
|
54
|
-
default: '
|
|
53
|
+
choices: ['local'],
|
|
54
|
+
default: 'local',
|
|
55
55
|
description:
|
|
56
|
-
|
|
56
|
+
'The server was generated without access to the Stainless API, so code execution can only run locally on the MCP server machine.',
|
|
57
57
|
})
|
|
58
58
|
.option('custom-instructions-path', {
|
|
59
59
|
type: 'string',
|
|
@@ -67,10 +67,10 @@ export function parseCLIOptions(): CLIOptions {
|
|
|
67
67
|
})
|
|
68
68
|
.option('docs-search-mode', {
|
|
69
69
|
type: 'string',
|
|
70
|
-
choices: ['
|
|
71
|
-
default: '
|
|
70
|
+
choices: ['local'],
|
|
71
|
+
default: 'local',
|
|
72
72
|
description:
|
|
73
|
-
"
|
|
73
|
+
"Documentation search will use an in-memory search index built from embedded SDK method data and optional local docs files; the 'stainless-api' option is unavailable.",
|
|
74
74
|
})
|
|
75
75
|
.option('log-format', {
|
|
76
76
|
type: 'string',
|
|
@@ -132,7 +132,7 @@ export function parseCLIOptions(): CLIOptions {
|
|
|
132
132
|
...(includeDocsTools !== undefined && { includeDocsTools }),
|
|
133
133
|
debug: !!argv.debug,
|
|
134
134
|
stainlessApiKey: argv.stainlessApiKey,
|
|
135
|
-
docsSearchMode: argv.docsSearchMode as '
|
|
135
|
+
docsSearchMode: argv.docsSearchMode as 'local' | undefined,
|
|
136
136
|
docsDir: argv.docsDir,
|
|
137
137
|
codeAllowHttpGets: argv.codeAllowHttpGets,
|
|
138
138
|
codeAllowedMethods: argv.codeAllowedMethods,
|
package/src/server.ts
CHANGED
|
@@ -28,7 +28,7 @@ export const newMcpServer = async ({
|
|
|
28
28
|
new McpServer(
|
|
29
29
|
{
|
|
30
30
|
name: 'conductor_node_api',
|
|
31
|
-
version: '14.23.
|
|
31
|
+
version: '14.23.2',
|
|
32
32
|
},
|
|
33
33
|
{
|
|
34
34
|
instructions: await getInstructions({ stainlessApiKey, customInstructionsPath }),
|
|
@@ -36,6 +36,14 @@ export const newMcpServer = async ({
|
|
|
36
36
|
},
|
|
37
37
|
);
|
|
38
38
|
|
|
39
|
+
// Build the local docs search index once per process, not once per request.
|
|
40
|
+
// The index derives from compile-time constants (plus an optional static
|
|
41
|
+
// docsDir), and initMcpServer runs on every HTTP request before any auth or
|
|
42
|
+
// Accept-header check, so rebuilding it per request lets tiny unauthenticated
|
|
43
|
+
// POSTs each burn megabytes of CPU (conductor self-hosting patch).
|
|
44
|
+
let _localSearchPromise: Promise<LocalDocsSearch> | undefined;
|
|
45
|
+
let _localSearchDocsDir: string | undefined;
|
|
46
|
+
|
|
39
47
|
/**
|
|
40
48
|
* Initializes the provided MCP Server with the given tools and handlers.
|
|
41
49
|
* If not provided, the default client, tools and handlers will be used.
|
|
@@ -68,8 +76,11 @@ export async function initMcpServer(params: {
|
|
|
68
76
|
|
|
69
77
|
if (params.mcpOptions?.docsSearchMode === 'local') {
|
|
70
78
|
const docsDir = params.mcpOptions?.docsDir;
|
|
71
|
-
|
|
72
|
-
|
|
79
|
+
if (!_localSearchPromise || _localSearchDocsDir !== docsDir) {
|
|
80
|
+
_localSearchDocsDir = docsDir;
|
|
81
|
+
_localSearchPromise = LocalDocsSearch.create(docsDir ? { docsDir } : undefined);
|
|
82
|
+
}
|
|
83
|
+
setLocalSearch(await _localSearchPromise);
|
|
73
84
|
}
|
|
74
85
|
|
|
75
86
|
let _client: Conductor | undefined;
|
|
@@ -182,7 +193,7 @@ export function selectTools(options?: McpOptions): McpTool[] {
|
|
|
182
193
|
includedTools.push(
|
|
183
194
|
codeTool({
|
|
184
195
|
blockedMethods: blockedMethodsForCodeTool(options),
|
|
185
|
-
codeExecutionMode: options?.codeExecutionMode ?? '
|
|
196
|
+
codeExecutionMode: options?.codeExecutionMode ?? 'local',
|
|
186
197
|
}),
|
|
187
198
|
);
|
|
188
199
|
}
|