Add TypeScript Agent SDK reference documentation

- Introduced comprehensive API reference for the TypeScript Agent SDK.
- Documented installation instructions for the SDK.
- Detailed the main functions: `query()`, `tool()`, and `createSdkMcpServer()`.
- Defined various types including `Options`, `Query`, `AgentDefinition`, and more.
- Included message types and their structures, such as `SDKMessage`, `SDKAssistantMessage`, and `SDKUserMessage`.
- Explained hook types and their usage within the SDK.
- Provided detailed documentation for tool input and output types.
- Added sections on permission types and other relevant types for better clarity.
This commit is contained in:
Alex Newman
2025-11-07 15:05:31 -05:00
parent 4bc467f7ed
commit 740d65b5a5
14 changed files with 2141 additions and 161 deletions
+2 -11
View File
@@ -37,18 +37,9 @@
"test:context:verbose": "echo '{\"session_id\":\"test-'$(date +%s)'\",\"cwd\":\"'$(pwd)'\",\"source\":\"startup\"}' | node plugin/scripts/context-hook.js",
"sync-marketplace": "rsync -av --delete --exclude=.git ./ ~/.claude/plugins/marketplaces/thedotmack/ && cd ~/.claude/plugins/marketplaces/thedotmack/ && npm install",
"worker:start": "pm2 start ecosystem.config.cjs",
"worker:stop": "pm2 stop claude-mem-worker 2>/dev/null || true",
"worker:restart": "pm2 restart claude-mem-worker 2>/dev/null || pm2 start ecosystem.config.cjs --only claude-mem-worker",
"worker:stop": "pm2 stop claude-mem-worker",
"worker:restart": "pm2 restart claude-mem-worker",
"worker:logs": "pm2 logs claude-mem-worker",
"worker:v1": "pm2 stop claude-mem-worker-v2 2>/dev/null || true && pm2 start ecosystem.config.cjs --only claude-mem-worker",
"worker:v2": "pm2 stop claude-mem-worker 2>/dev/null || true && pm2 start ecosystem.config.cjs --only claude-mem-worker-v2",
"worker:start:v1": "pm2 start ecosystem.config.cjs --only claude-mem-worker",
"worker:start:v2": "pm2 start ecosystem.config.cjs --only claude-mem-worker-v2",
"worker:stop:v1": "pm2 stop claude-mem-worker",
"worker:stop:v2": "pm2 stop claude-mem-worker-v2",
"worker:restart:v1": "pm2 restart claude-mem-worker",
"worker:restart:v2": "pm2 restart claude-mem-worker-v2",
"worker:logs:v2": "pm2 logs claude-mem-worker-v2",
"usage:analyze": "node scripts/analyze-usage.js",
"usage:today": "node scripts/analyze-usage.js $(date +%Y-%m-%d)"
},