open_by_key
Access InterSystems IRIS ObjectScript documentation pages directly using their official document keys to find specific technical information quickly.
Instructions
Open a documentation page by its official KEY
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | Document key |
Implementation Reference
- src/request/call-schema.request.ts:45-60 (handler)Handler logic for the 'open_by_key' tool: extracts 'key' from arguments, fetches document content using fetchDocByKey, and returns it as text content.
case "open_by_key": { const key = args?.key as string; if (!key) { throw new Error("Key is required"); } const content = await fetchDocByKey(key); return { content: [ { type: "text", text: content.text, }, ], }; } - src/tools/open-by-key.tool.ts:3-17 (schema)Tool definition including name, description, and input schema requiring a 'key' string.
export const OPEN_BY_KEY: Tool = { name: "open_by_key", description: "Open a documentation page by its official KEY", inputSchema: { type: "object", properties: { key: { type: "string", description: "Document key", minLength: 3, }, }, required: ["key"], }, }; - src/tools/core.tool.ts:18-22 (registration)Registration of the 'open_by_key' tool (as OPEN_BY_KEY) in the core tools array provided by coreTools function.
export const coreTools = async () => { return { tools: [SMART_SEARCH, SEARCH_OBJECTSCRIPT, OPEN_BY_KEY, OPEN_CLASS], }; };