hive-skills 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +28 -0
- package/README.md +235 -0
- package/assets/LICENSE +32 -0
- package/assets/THIRD_PARTY_NOTICES.md +72 -0
- package/assets/manifest.json +1290 -0
- package/assets/skills/authored/code-review/composable/BUNDLE.md +192 -0
- package/assets/skills/authored/code-review/composable/INDEX.md +13 -0
- package/assets/skills/authored/code-review/composable/VERSION +1 -0
- package/assets/skills/authored/code-review/composable/mini/01-review-method.md +34 -0
- package/assets/skills/authored/code-review/composable/mini/02-security-review.md +20 -0
- package/assets/skills/authored/code-review/composable/mini/03-correctness-bugs.md +19 -0
- package/assets/skills/authored/code-review/composable/mini/04-concurrency.md +16 -0
- package/assets/skills/authored/code-review/composable/mini/05-error-handling.md +12 -0
- package/assets/skills/authored/code-review/composable/mini/06-performance.md +11 -0
- package/assets/skills/authored/code-review/composable/mini/07-api-design.md +20 -0
- package/assets/skills/authored/code-review/composable/mini/08-missing-tests.md +25 -0
- package/assets/skills/authored/code-review/composable/mini/09-refactoring-and-communication.md +32 -0
- package/assets/skills/authored/data-analysis/composable/BUNDLE.md +186 -0
- package/assets/skills/authored/data-analysis/composable/INDEX.md +13 -0
- package/assets/skills/authored/data-analysis/composable/VERSION +1 -0
- package/assets/skills/authored/data-analysis/composable/mini/01-data-quality-profiling.md +26 -0
- package/assets/skills/authored/data-analysis/composable/mini/02-aggregation-pitfalls.md +21 -0
- package/assets/skills/authored/data-analysis/composable/mini/03-time-series.md +19 -0
- package/assets/skills/authored/data-analysis/composable/mini/04-segmentation.md +23 -0
- package/assets/skills/authored/data-analysis/composable/mini/05-discount-pricing.md +17 -0
- package/assets/skills/authored/data-analysis/composable/mini/06-insight-generation.md +25 -0
- package/assets/skills/authored/data-analysis/composable/mini/07-executive-writing.md +26 -0
- package/assets/skills/authored/data-analysis/composable/mini/08-recommendations.md +20 -0
- package/assets/skills/authored/data-analysis/composable/mini/09-reproducibility-assumptions.md +20 -0
- package/assets/skills/authored/financial-analysis/composable/BUNDLE.md +1293 -0
- package/assets/skills/authored/financial-analysis/composable/INDEX.md +17 -0
- package/assets/skills/authored/financial-analysis/composable/VERSION +1 -0
- package/assets/skills/authored/financial-analysis/composable/mini/00-core.md +69 -0
- package/assets/skills/authored/financial-analysis/composable/mini/01-profitability-efficiency-ratios.md +173 -0
- package/assets/skills/authored/financial-analysis/composable/mini/02-liquidity-leverage-ratios.md +120 -0
- package/assets/skills/authored/financial-analysis/composable/mini/03-valuation-ratios-interpretation.md +107 -0
- package/assets/skills/authored/financial-analysis/composable/mini/04-dcf-projection-wacc.md +122 -0
- package/assets/skills/authored/financial-analysis/composable/mini/05-dcf-terminal-value-sensitivity.md +75 -0
- package/assets/skills/authored/financial-analysis/composable/mini/06-comparables-precedents.md +78 -0
- package/assets/skills/authored/financial-analysis/composable/mini/07-budget-variance-analysis.md +47 -0
- package/assets/skills/authored/financial-analysis/composable/mini/08-driver-based-forecasting-scenarios.md +111 -0
- package/assets/skills/authored/financial-analysis/composable/mini/09-rolling-forecasts-accuracy.md +114 -0
- package/assets/skills/authored/financial-analysis/composable/mini/10-reporting-exec-summary.md +58 -0
- package/assets/skills/authored/financial-analysis/composable/mini/11-industry-adaptations.md +130 -0
- package/assets/skills/authored/financial-analysis/composable/mini/12-toolkit-scripts-io.md +102 -0
- package/assets/skills/authored/python-api/composable/BUNDLE.md +389 -0
- package/assets/skills/authored/python-api/composable/INDEX.md +13 -0
- package/assets/skills/authored/python-api/composable/VERSION +1 -0
- package/assets/skills/authored/python-api/composable/mini/01-project-structure.md +44 -0
- package/assets/skills/authored/python-api/composable/mini/02-routing-and-app.md +38 -0
- package/assets/skills/authored/python-api/composable/mini/03-pydantic-models.md +45 -0
- package/assets/skills/authored/python-api/composable/mini/04-validation-and-errors.md +59 -0
- package/assets/skills/authored/python-api/composable/mini/05-dependencies-and-auth.md +60 -0
- package/assets/skills/authored/python-api/composable/mini/06-pagination-filtering.md +44 -0
- package/assets/skills/authored/python-api/composable/mini/07-async-performance.md +30 -0
- package/assets/skills/authored/python-api/composable/mini/08-testing.md +45 -0
- package/assets/skills/authored/python-api/composable/mini/09-middleware-observability.md +29 -0
- package/assets/skills/authored/tech-writing/composable/BUNDLE.md +220 -0
- package/assets/skills/authored/tech-writing/composable/INDEX.md +12 -0
- package/assets/skills/authored/tech-writing/composable/VERSION +1 -0
- package/assets/skills/authored/tech-writing/composable/mini/01-audience-analysis.md +26 -0
- package/assets/skills/authored/tech-writing/composable/mini/02-document-types.md +27 -0
- package/assets/skills/authored/tech-writing/composable/mini/03-readme-quickstart-changelog.md +22 -0
- package/assets/skills/authored/tech-writing/composable/mini/04-information-architecture.md +21 -0
- package/assets/skills/authored/tech-writing/composable/mini/05-style-clarity.md +29 -0
- package/assets/skills/authored/tech-writing/composable/mini/06-breaking-changes-migrations.md +33 -0
- package/assets/skills/authored/tech-writing/composable/mini/07-troubleshooting-security.md +30 -0
- package/assets/skills/authored/tech-writing/composable/mini/08-faq-voice-tone.md +32 -0
- package/assets/skills/converted/claude-api/composable/BUNDLE.md +14996 -0
- package/assets/skills/converted/claude-api/composable/INDEX.md +98 -0
- package/assets/skills/converted/claude-api/composable/VERSION +1 -0
- package/assets/skills/converted/claude-api/composable/mini/00-core.md +235 -0
- package/assets/skills/converted/claude-api/composable/mini/01-model-api-quick-reference.md +258 -0
- package/assets/skills/converted/claude-api/composable/mini/02-common-pitfalls.md +42 -0
- package/assets/skills/converted/claude-api/composable/mini/10-models.md +135 -0
- package/assets/skills/converted/claude-api/composable/mini/11-platform-availability.md +96 -0
- package/assets/skills/converted/claude-api/composable/mini/12-claude-platform-on-aws.md +59 -0
- package/assets/skills/converted/claude-api/composable/mini/13-live-sources.md +143 -0
- package/assets/skills/converted/claude-api/composable/mini/14-error-codes.md +256 -0
- package/assets/skills/converted/claude-api/composable/mini/15-prompt-caching.md +223 -0
- package/assets/skills/converted/claude-api/composable/mini/16-token-counting.md +56 -0
- package/assets/skills/converted/claude-api/composable/mini/17-tool-use-concepts.md +444 -0
- package/assets/skills/converted/claude-api/composable/mini/18-agent-design.md +101 -0
- package/assets/skills/converted/claude-api/composable/mini/19-anthropic-cli.md +246 -0
- package/assets/skills/converted/claude-api/composable/mini/20-model-migration.md +1301 -0
- package/assets/skills/converted/claude-api/composable/mini/30-managed-agents-overview.md +71 -0
- package/assets/skills/converted/claude-api/composable/mini/31-managed-agents-core.md +278 -0
- package/assets/skills/converted/claude-api/composable/mini/32-managed-agents-environments.md +219 -0
- package/assets/skills/converted/claude-api/composable/mini/33-managed-agents-tools.md +366 -0
- package/assets/skills/converted/claude-api/composable/mini/34-managed-agents-events.md +252 -0
- package/assets/skills/converted/claude-api/composable/mini/35-managed-agents-outcomes.md +106 -0
- package/assets/skills/converted/claude-api/composable/mini/36-managed-agents-multiagent.md +101 -0
- package/assets/skills/converted/claude-api/composable/mini/37-managed-agents-webhooks.md +123 -0
- package/assets/skills/converted/claude-api/composable/mini/38-managed-agents-memory.md +197 -0
- package/assets/skills/converted/claude-api/composable/mini/39-managed-agents-scheduled-deployments.md +146 -0
- package/assets/skills/converted/claude-api/composable/mini/40-managed-agents-client-patterns.md +211 -0
- package/assets/skills/converted/claude-api/composable/mini/41-managed-agents-onboarding.md +82 -0
- package/assets/skills/converted/claude-api/composable/mini/42-managed-agents-api-reference.md +441 -0
- package/assets/skills/converted/claude-api/composable/mini/43-managed-agents-self-hosted-sandboxes.md +174 -0
- package/assets/skills/converted/claude-api/composable/mini/50-python-readme.md +564 -0
- package/assets/skills/converted/claude-api/composable/mini/51-python-tool-use.md +590 -0
- package/assets/skills/converted/claude-api/composable/mini/52-python-streaming-batches-files.md +549 -0
- package/assets/skills/converted/claude-api/composable/mini/53-python-managed-agents.md +335 -0
- package/assets/skills/converted/claude-api/composable/mini/55-typescript-readme.md +404 -0
- package/assets/skills/converted/claude-api/composable/mini/56-typescript-tool-use.md +548 -0
- package/assets/skills/converted/claude-api/composable/mini/57-typescript-streaming-batches-files.md +384 -0
- package/assets/skills/converted/claude-api/composable/mini/58-typescript-managed-agents.md +358 -0
- package/assets/skills/converted/claude-api/composable/mini/60-csharp-readme.md +361 -0
- package/assets/skills/converted/claude-api/composable/mini/61-csharp-tool-use.md +163 -0
- package/assets/skills/converted/claude-api/composable/mini/62-csharp-streaming-batches-files.md +64 -0
- package/assets/skills/converted/claude-api/composable/mini/65-go-readme.md +185 -0
- package/assets/skills/converted/claude-api/composable/mini/66-go-tool-use.md +219 -0
- package/assets/skills/converted/claude-api/composable/mini/67-go-streaming-files.md +63 -0
- package/assets/skills/converted/claude-api/composable/mini/68-go-managed-agents.md +564 -0
- package/assets/skills/converted/claude-api/composable/mini/70-java-readme.md +237 -0
- package/assets/skills/converted/claude-api/composable/mini/71-java-tool-use.md +227 -0
- package/assets/skills/converted/claude-api/composable/mini/72-java-streaming-files.md +49 -0
- package/assets/skills/converted/claude-api/composable/mini/73-java-managed-agents.md +443 -0
- package/assets/skills/converted/claude-api/composable/mini/75-php-readme.md +173 -0
- package/assets/skills/converted/claude-api/composable/mini/76-php-tool-use.md +252 -0
- package/assets/skills/converted/claude-api/composable/mini/77-php-streaming-batches-files.md +53 -0
- package/assets/skills/converted/claude-api/composable/mini/78-php-managed-agents.md +443 -0
- package/assets/skills/converted/claude-api/composable/mini/80-ruby-readme.md +133 -0
- package/assets/skills/converted/claude-api/composable/mini/81-ruby-tool-use-streaming.md +56 -0
- package/assets/skills/converted/claude-api/composable/mini/82-ruby-managed-agents.md +394 -0
- package/assets/skills/converted/claude-api/composable/mini/85-curl-examples.md +255 -0
- package/assets/skills/converted/claude-api/composable/mini/86-curl-managed-agents.md +340 -0
- package/assets/skills/converted/claude-api/composable/presets/csharp.md +1151 -0
- package/assets/skills/converted/claude-api/composable/presets/curl.md +1154 -0
- package/assets/skills/converted/claude-api/composable/presets/go.md +1598 -0
- package/assets/skills/converted/claude-api/composable/presets/java.md +1523 -0
- package/assets/skills/converted/claude-api/composable/presets/php.md +1488 -0
- package/assets/skills/converted/claude-api/composable/presets/python.md +2605 -0
- package/assets/skills/converted/claude-api/composable/presets/ruby.md +1146 -0
- package/assets/skills/converted/claude-api/composable/presets/shared.md +6478 -0
- package/assets/skills/converted/claude-api/composable/presets/typescript.md +2261 -0
- package/assets/skills/converted/docx/composable/BUNDLE.md +617 -0
- package/assets/skills/converted/docx/composable/INDEX.md +12 -0
- package/assets/skills/converted/docx/composable/VERSION +1 -0
- package/assets/skills/converted/docx/composable/mini/00-core.md +26 -0
- package/assets/skills/converted/docx/composable/mini/01-reading-converting.md +36 -0
- package/assets/skills/converted/docx/composable/mini/02-creating-setup-layout.md +85 -0
- package/assets/skills/converted/docx/composable/mini/03-creating-elements.md +257 -0
- package/assets/skills/converted/docx/composable/mini/04-editing-existing.md +57 -0
- package/assets/skills/converted/docx/composable/mini/05-xml-reference.md +128 -0
- package/assets/skills/converted/internal-comms/composable/BUNDLE.md +220 -0
- package/assets/skills/converted/internal-comms/composable/INDEX.md +11 -0
- package/assets/skills/converted/internal-comms/composable/VERSION +1 -0
- package/assets/skills/converted/internal-comms/composable/mini/00-core.md +30 -0
- package/assets/skills/converted/internal-comms/composable/mini/01-3p-updates.md +49 -0
- package/assets/skills/converted/internal-comms/composable/mini/02-company-newsletter.md +67 -0
- package/assets/skills/converted/internal-comms/composable/mini/03-faq-answers.md +32 -0
- package/assets/skills/converted/internal-comms/composable/mini/04-general-comms.md +18 -0
- package/assets/skills/converted/mcp-builder/composable/BUNDLE.md +2460 -0
- package/assets/skills/converted/mcp-builder/composable/INDEX.md +23 -0
- package/assets/skills/converted/mcp-builder/composable/VERSION +1 -0
- package/assets/skills/converted/mcp-builder/composable/mini/00-core.md +43 -0
- package/assets/skills/converted/mcp-builder/composable/mini/01-workflow-research-planning.md +54 -0
- package/assets/skills/converted/mcp-builder/composable/mini/02-implementation-process.md +78 -0
- package/assets/skills/converted/mcp-builder/composable/mini/03-naming-conventions.md +33 -0
- package/assets/skills/converted/mcp-builder/composable/mini/04-response-formats.md +21 -0
- package/assets/skills/converted/mcp-builder/composable/mini/05-pagination.md +24 -0
- package/assets/skills/converted/mcp-builder/composable/mini/06-transport.md +47 -0
- package/assets/skills/converted/mcp-builder/composable/mini/07-annotations.md +20 -0
- package/assets/skills/converted/mcp-builder/composable/mini/08-security.md +35 -0
- package/assets/skills/converted/mcp-builder/composable/mini/09-error-handling.md +32 -0
- package/assets/skills/converted/mcp-builder/composable/mini/10-testing-and-documentation.md +21 -0
- package/assets/skills/converted/mcp-builder/composable/mini/11-python-implementation.md +432 -0
- package/assets/skills/converted/mcp-builder/composable/mini/12-python-advanced-and-checklist.md +233 -0
- package/assets/skills/converted/mcp-builder/composable/mini/13-node-implementation.md +717 -0
- package/assets/skills/converted/mcp-builder/composable/mini/14-node-advanced-and-checklist.md +200 -0
- package/assets/skills/converted/mcp-builder/composable/mini/15-evaluation-design.md +200 -0
- package/assets/skills/converted/mcp-builder/composable/mini/16-evaluation-running.md +198 -0
- package/assets/skills/converted/mcp-builder/composable/presets/node-server.md +1381 -0
- package/assets/skills/converted/mcp-builder/composable/presets/python-server.md +1129 -0
- package/assets/skills/converted/pdf/composable/BUNDLE.md +1284 -0
- package/assets/skills/converted/pdf/composable/INDEX.md +14 -0
- package/assets/skills/converted/pdf/composable/VERSION +1 -0
- package/assets/skills/converted/pdf/composable/mini/00-core.md +46 -0
- package/assets/skills/converted/pdf/composable/mini/01-creation.md +176 -0
- package/assets/skills/converted/pdf/composable/mini/02-extraction.md +178 -0
- package/assets/skills/converted/pdf/composable/mini/03-merge-split-manipulate.md +240 -0
- package/assets/skills/converted/pdf/composable/mini/04-images-ocr.md +168 -0
- package/assets/skills/converted/pdf/composable/mini/05-encryption.md +51 -0
- package/assets/skills/converted/pdf/composable/mini/06-forms.md +300 -0
- package/assets/skills/converted/pdf/composable/mini/07-libraries-reference.md +89 -0
- package/assets/skills/converted/pptx/composable/BUNDLE.md +911 -0
- package/assets/skills/converted/pptx/composable/INDEX.md +12 -0
- package/assets/skills/converted/pptx/composable/VERSION +1 -0
- package/assets/skills/converted/pptx/composable/mini/00-core.md +37 -0
- package/assets/skills/converted/pptx/composable/mini/01-reading.md +37 -0
- package/assets/skills/converted/pptx/composable/mini/02-creating-from-scratch.md +422 -0
- package/assets/skills/converted/pptx/composable/mini/03-editing-templates.md +207 -0
- package/assets/skills/converted/pptx/composable/mini/04-design.md +89 -0
- package/assets/skills/converted/pptx/composable/mini/05-qa-and-rendering.md +91 -0
- package/assets/skills/converted/pptx/composable/presets/creating.md +659 -0
- package/assets/skills/converted/pptx/composable/presets/editing.md +485 -0
- package/assets/skills/converted/skill-creator/composable/BUNDLE.md +1681 -0
- package/assets/skills/converted/skill-creator/composable/INDEX.md +21 -0
- package/assets/skills/converted/skill-creator/composable/VERSION +1 -0
- package/assets/skills/converted/skill-creator/composable/mini/00-core.md +59 -0
- package/assets/skills/converted/skill-creator/composable/mini/01-creating-a-skill.md +27 -0
- package/assets/skills/converted/skill-creator/composable/mini/02-skill-writing-guide.md +71 -0
- package/assets/skills/converted/skill-creator/composable/mini/03-test-cases.md +21 -0
- package/assets/skills/converted/skill-creator/composable/mini/04-running-and-evaluating.md +128 -0
- package/assets/skills/converted/skill-creator/composable/mini/05-improving-the-skill.md +30 -0
- package/assets/skills/converted/skill-creator/composable/mini/06-blind-comparison.md +5 -0
- package/assets/skills/converted/skill-creator/composable/mini/07-description-optimization.md +74 -0
- package/assets/skills/converted/skill-creator/composable/mini/08-packaging.md +11 -0
- package/assets/skills/converted/skill-creator/composable/mini/09-environment-specific.md +38 -0
- package/assets/skills/converted/skill-creator/composable/mini/10-scripts-and-references.md +34 -0
- package/assets/skills/converted/skill-creator/composable/mini/11-json-schemas.md +414 -0
- package/assets/skills/converted/skill-creator/composable/mini/12-agent-grader.md +225 -0
- package/assets/skills/converted/skill-creator/composable/mini/13-agent-comparator.md +204 -0
- package/assets/skills/converted/skill-creator/composable/mini/14-agent-analyzer.md +276 -0
- package/assets/skills/converted/skill-creator/composable/presets/authoring.md +198 -0
- package/assets/skills/converted/skill-creator/composable/presets/evaluating.md +1334 -0
- package/assets/skills/converted/skill-creator/composable/presets/optimizing.md +160 -0
- package/assets/skills/converted/skill-creator/composable/presets.json +5 -0
- package/assets/skills/meta/ccs-skill-creator/composable/BUNDLE.md +465 -0
- package/assets/skills/meta/ccs-skill-creator/composable/INDEX.md +8 -0
- package/assets/skills/meta/ccs-skill-creator/composable/VERSION +1 -0
- package/assets/skills/meta/ccs-skill-creator/composable/mini/00-core.md +46 -0
- package/assets/skills/meta/ccs-skill-creator/composable/mini/01-create-new-skill.md +167 -0
- package/assets/skills/meta/ccs-skill-creator/composable/mini/02-convert-existing-skill.md +120 -0
- package/assets/skills/meta/ccs-skill-creator/composable/mini/03-review-and-maintain.md +112 -0
- package/assets/skills/sources/anthropic/PROVENANCE.md +3 -0
- package/assets/skills/sources/anthropic/claude-api/LICENSE.txt +202 -0
- package/assets/skills/sources/anthropic/docx/LICENSE.txt +30 -0
- package/assets/skills/sources/anthropic/internal-comms/LICENSE.txt +202 -0
- package/assets/skills/sources/anthropic/mcp-builder/LICENSE.txt +202 -0
- package/assets/skills/sources/anthropic/pdf/LICENSE.txt +30 -0
- package/assets/skills/sources/anthropic/pptx/LICENSE.txt +30 -0
- package/assets/skills/sources/anthropic/skill-creator/LICENSE.txt +202 -0
- package/assets/skills/sources/financial-analyst/PROVENANCE.md +1 -0
- package/assets/tools/hive.py +728 -0
- package/dist/cli.js +7494 -0
- package/package.json +40 -0
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
# Tool Use — PHP
|
|
2
|
+
|
|
3
|
+
For conceptual overview (tool definitions, tool choice, tips), see [shared/tool-use-concepts.md](../../shared/tool-use-concepts.md).
|
|
4
|
+
|
|
5
|
+
## Tool Use
|
|
6
|
+
|
|
7
|
+
### Tool Runner (Beta)
|
|
8
|
+
|
|
9
|
+
**Beta:** The PHP SDK provides a tool runner via `$client->beta->messages->toolRunner()`. Define tools with `BetaRunnableTool` — a definition array plus a `run` closure:
|
|
10
|
+
|
|
11
|
+
```php
|
|
12
|
+
use Anthropic\Lib\Tools\BetaRunnableTool;
|
|
13
|
+
|
|
14
|
+
$weatherTool = new BetaRunnableTool(
|
|
15
|
+
definition: [
|
|
16
|
+
'name' => 'get_weather',
|
|
17
|
+
'description' => 'Get the current weather for a location.',
|
|
18
|
+
'inputSchema' => [
|
|
19
|
+
'type' => 'object',
|
|
20
|
+
'properties' => [
|
|
21
|
+
'location' => ['type' => 'string', 'description' => 'City and state'],
|
|
22
|
+
],
|
|
23
|
+
'required' => ['location'],
|
|
24
|
+
],
|
|
25
|
+
],
|
|
26
|
+
run: function (array $input): string {
|
|
27
|
+
return "The weather in {$input['location']} is sunny and 72°F.";
|
|
28
|
+
},
|
|
29
|
+
);
|
|
30
|
+
|
|
31
|
+
$runner = $client->beta->messages->toolRunner(
|
|
32
|
+
maxTokens: 16000,
|
|
33
|
+
messages: [['role' => 'user', 'content' => 'What is the weather in Paris?']],
|
|
34
|
+
model: 'claude-opus-4-8',
|
|
35
|
+
tools: [$weatherTool],
|
|
36
|
+
);
|
|
37
|
+
|
|
38
|
+
foreach ($runner as $message) {
|
|
39
|
+
foreach ($message->content as $block) {
|
|
40
|
+
if ($block->type === 'text') {
|
|
41
|
+
echo $block->text;
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Manual Loop
|
|
48
|
+
|
|
49
|
+
Tools are passed as arrays. **The SDK uses camelCase keys** (`inputSchema`, `toolUseID`, `stopReason`) and auto-maps to the API's snake_case on the wire — since v0.5.0. See [shared tool use concepts](../../shared/tool-use-concepts.md) for the loop pattern.
|
|
50
|
+
|
|
51
|
+
```php
|
|
52
|
+
use Anthropic\Messages\ToolUseBlock;
|
|
53
|
+
|
|
54
|
+
$tools = [
|
|
55
|
+
[
|
|
56
|
+
'name' => 'get_weather',
|
|
57
|
+
'description' => 'Get the current weather in a given location',
|
|
58
|
+
'inputSchema' => [ // camelCase, not input_schema
|
|
59
|
+
'type' => 'object',
|
|
60
|
+
'properties' => [
|
|
61
|
+
'location' => ['type' => 'string', 'description' => 'City and state'],
|
|
62
|
+
],
|
|
63
|
+
'required' => ['location'],
|
|
64
|
+
],
|
|
65
|
+
],
|
|
66
|
+
];
|
|
67
|
+
|
|
68
|
+
$messages = [['role' => 'user', 'content' => 'What is the weather in SF?']];
|
|
69
|
+
|
|
70
|
+
$response = $client->messages->create(
|
|
71
|
+
model: 'claude-opus-4-8',
|
|
72
|
+
maxTokens: 16000,
|
|
73
|
+
tools: $tools,
|
|
74
|
+
messages: $messages,
|
|
75
|
+
);
|
|
76
|
+
|
|
77
|
+
while ($response->stopReason === 'tool_use') { // camelCase property
|
|
78
|
+
$toolResults = [];
|
|
79
|
+
foreach ($response->content as $block) {
|
|
80
|
+
if ($block instanceof ToolUseBlock) {
|
|
81
|
+
// $block->name : string — tool name to dispatch on
|
|
82
|
+
// $block->input : array<string,mixed> — parsed JSON input
|
|
83
|
+
// $block->id : string — pass back as toolUseID
|
|
84
|
+
$result = executeYourTool($block->name, $block->input);
|
|
85
|
+
$toolResults[] = [
|
|
86
|
+
'type' => 'tool_result',
|
|
87
|
+
'toolUseID' => $block->id, // camelCase, not tool_use_id
|
|
88
|
+
'content' => $result,
|
|
89
|
+
];
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
// Append assistant turn + user turn with tool results
|
|
94
|
+
$messages[] = ['role' => 'assistant', 'content' => $response->content];
|
|
95
|
+
$messages[] = ['role' => 'user', 'content' => $toolResults];
|
|
96
|
+
|
|
97
|
+
$response = $client->messages->create(
|
|
98
|
+
model: 'claude-opus-4-8',
|
|
99
|
+
maxTokens: 16000,
|
|
100
|
+
tools: $tools,
|
|
101
|
+
messages: $messages,
|
|
102
|
+
);
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
// Final text response
|
|
106
|
+
foreach ($response->content as $block) {
|
|
107
|
+
if ($block->type === 'text') {
|
|
108
|
+
echo $block->text;
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
`$block->type === 'tool_use'` also works; `instanceof ToolUseBlock` narrows for PHPStan.
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
## Structured Outputs
|
|
119
|
+
|
|
120
|
+
### Using StructuredOutputModel (Recommended)
|
|
121
|
+
|
|
122
|
+
Define a PHP class implementing `StructuredOutputModel` and pass it as `outputConfig`:
|
|
123
|
+
|
|
124
|
+
```php
|
|
125
|
+
use Anthropic\Lib\Contracts\StructuredOutputModel;
|
|
126
|
+
use Anthropic\Lib\Concerns\StructuredOutputModelTrait;
|
|
127
|
+
use Anthropic\Lib\Attributes\Constrained;
|
|
128
|
+
|
|
129
|
+
class Person implements StructuredOutputModel
|
|
130
|
+
{
|
|
131
|
+
use StructuredOutputModelTrait;
|
|
132
|
+
|
|
133
|
+
#[Constrained(description: 'Full name')]
|
|
134
|
+
public string $name;
|
|
135
|
+
|
|
136
|
+
public int $age;
|
|
137
|
+
|
|
138
|
+
public ?string $email = null; // nullable = optional field
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
$message = $client->messages->create(
|
|
142
|
+
model: 'claude-opus-4-8',
|
|
143
|
+
maxTokens: 16000,
|
|
144
|
+
messages: [['role' => 'user', 'content' => 'Generate a profile for Alice, age 30']],
|
|
145
|
+
outputConfig: ['format' => Person::class],
|
|
146
|
+
);
|
|
147
|
+
|
|
148
|
+
$person = $message->parsedOutput(); // Person instance
|
|
149
|
+
echo $person->name;
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
Types are inferred from PHP type hints. Use `#[Constrained(description: '...')]` to add descriptions. Nullable properties (`?string`) become optional fields.
|
|
153
|
+
|
|
154
|
+
### Raw Schema
|
|
155
|
+
|
|
156
|
+
```php
|
|
157
|
+
$message = $client->messages->create(
|
|
158
|
+
model: 'claude-opus-4-8',
|
|
159
|
+
maxTokens: 16000,
|
|
160
|
+
messages: [['role' => 'user', 'content' => 'Extract: John (john@co.com), Enterprise plan']],
|
|
161
|
+
outputConfig: [
|
|
162
|
+
'format' => [
|
|
163
|
+
'type' => 'json_schema',
|
|
164
|
+
'schema' => [
|
|
165
|
+
'type' => 'object',
|
|
166
|
+
'properties' => [
|
|
167
|
+
'name' => ['type' => 'string'],
|
|
168
|
+
'email' => ['type' => 'string'],
|
|
169
|
+
'plan' => ['type' => 'string'],
|
|
170
|
+
],
|
|
171
|
+
'required' => ['name', 'email', 'plan'],
|
|
172
|
+
'additionalProperties' => false,
|
|
173
|
+
],
|
|
174
|
+
],
|
|
175
|
+
],
|
|
176
|
+
);
|
|
177
|
+
|
|
178
|
+
// First text block contains valid JSON
|
|
179
|
+
foreach ($message->content as $block) {
|
|
180
|
+
if ($block->type === 'text') {
|
|
181
|
+
$data = json_decode($block->text, true);
|
|
182
|
+
break;
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
---
|
|
188
|
+
|
|
189
|
+
## Beta Features & Anthropic-Defined Tools
|
|
190
|
+
|
|
191
|
+
**`betas:` is NOT a param on `$client->messages->create()`** — it only exists on the beta namespace. Use it for features that need an explicit opt-in header:
|
|
192
|
+
|
|
193
|
+
```php
|
|
194
|
+
use Anthropic\Beta\Messages\BetaRequestMCPServerURLDefinition;
|
|
195
|
+
|
|
196
|
+
$response = $client->beta->messages->create(
|
|
197
|
+
model: 'claude-opus-4-8',
|
|
198
|
+
maxTokens: 16000,
|
|
199
|
+
mcpServers: [
|
|
200
|
+
BetaRequestMCPServerURLDefinition::with(
|
|
201
|
+
name: 'my-server',
|
|
202
|
+
url: 'https://example.com/mcp',
|
|
203
|
+
),
|
|
204
|
+
],
|
|
205
|
+
betas: ['mcp-client-2025-11-20'], // only valid on ->beta->messages
|
|
206
|
+
messages: [['role' => 'user', 'content' => 'Use the MCP tools']],
|
|
207
|
+
);
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### Task budgets
|
|
211
|
+
|
|
212
|
+
```php
|
|
213
|
+
$response = $client->beta->messages->create(
|
|
214
|
+
model: 'claude-opus-4-8',
|
|
215
|
+
maxTokens: 16000,
|
|
216
|
+
outputConfig: ['taskBudget' => ['type' => 'tokens', 'total' => 64000]],
|
|
217
|
+
tools: [...],
|
|
218
|
+
messages: [...],
|
|
219
|
+
betas: ['task-budgets-2026-03-13'],
|
|
220
|
+
);
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### Cache diagnostics
|
|
224
|
+
|
|
225
|
+
Pass the previous response's `id` on the next request; print the `diagnostics` object on the response:
|
|
226
|
+
|
|
227
|
+
```php
|
|
228
|
+
$r2 = $client->beta->messages->create(
|
|
229
|
+
model: 'claude-opus-4-8', maxTokens: 1024,
|
|
230
|
+
diagnostics: ['previousMessageId' => $r1->id],
|
|
231
|
+
betas: ['cache-diagnosis-2026-04-07'],
|
|
232
|
+
messages: [...],
|
|
233
|
+
);
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
**Anthropic-defined tools** (bash, web_search, text_editor, code_execution) are GA and work on both paths. Of these, web_search and code_execution are server-executed; bash and text_editor are client-executed (you handle the `tool_use` locally) — `Anthropic\Messages\ToolBash20250124` / `WebSearchTool20260209` / `ToolTextEditor20250728` / `CodeExecutionTool20260120` for non-beta, `Anthropic\Beta\Messages\BetaToolBash20250124` / `BetaWebSearchTool20260209` / `BetaToolTextEditor20250728` / `BetaCodeExecutionTool20260120` for beta. No `betas:` header needed for these.
|
|
237
|
+
|
|
238
|
+
### Tool search (non-beta, server-side)
|
|
239
|
+
|
|
240
|
+
```php
|
|
241
|
+
tools: [
|
|
242
|
+
['type' => 'tool_search_tool_regex_20251119', 'name' => 'tool_search_tool_regex'],
|
|
243
|
+
['name' => 'get_weather', 'description' => '...', 'inputSchema' => [...], 'deferLoading' => true],
|
|
244
|
+
// ... other user tools with 'deferLoading' => true
|
|
245
|
+
],
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
### Memory tool (non-beta, client-executed)
|
|
249
|
+
|
|
250
|
+
Declare `['type' => 'memory_20250818', 'name' => 'memory']`. Handle the `tool_use` by reading/writing files under a fixed `/memories` directory. **Validate every model-supplied path**: resolve to its canonical form and verify it remains within the memory directory; reject traversal (`..`, symlinks) — see `shared/tool-use-concepts.md` § Client-Side Tools.
|
|
251
|
+
|
|
252
|
+
---
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# Streaming — PHP
|
|
2
|
+
|
|
3
|
+
## Streaming
|
|
4
|
+
|
|
5
|
+
> **Requires SDK v0.5.0+.** v0.4.0 and earlier used a single `$params` array; calling with named parameters throws `Unknown named parameter $model`. Upgrade: `composer require "anthropic-ai/sdk:^0.7"`
|
|
6
|
+
|
|
7
|
+
```php
|
|
8
|
+
use Anthropic\Messages\RawContentBlockDeltaEvent;
|
|
9
|
+
use Anthropic\Messages\TextDelta;
|
|
10
|
+
|
|
11
|
+
$stream = $client->messages->createStream(
|
|
12
|
+
model: 'claude-opus-4-8',
|
|
13
|
+
maxTokens: 64000,
|
|
14
|
+
messages: [
|
|
15
|
+
['role' => 'user', 'content' => 'Write a haiku'],
|
|
16
|
+
],
|
|
17
|
+
);
|
|
18
|
+
|
|
19
|
+
foreach ($stream as $event) {
|
|
20
|
+
if ($event instanceof RawContentBlockDeltaEvent && $event->delta instanceof TextDelta) {
|
|
21
|
+
echo $event->delta->text;
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
# Message Batches — PHP
|
|
29
|
+
|
|
30
|
+
## Message Batches API
|
|
31
|
+
|
|
32
|
+
```php
|
|
33
|
+
$batch = $client->messages->batches->create(requests: [
|
|
34
|
+
['customId' => 'req-1', 'params' => ['model' => 'claude-opus-4-8', 'maxTokens' => 1024, 'messages' => [...]]],
|
|
35
|
+
['customId' => 'req-2', 'params' => [...]],
|
|
36
|
+
]);
|
|
37
|
+
// Poll $client->messages->batches->retrieve($batch->id) until processingStatus === 'ended',
|
|
38
|
+
// then iterate $client->messages->batches->results($batch->id).
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
# Files API — PHP
|
|
44
|
+
|
|
45
|
+
## Files API
|
|
46
|
+
|
|
47
|
+
```php
|
|
48
|
+
$file = $client->beta->files->upload(
|
|
49
|
+
file: fopen('upload_me.txt', 'r'),
|
|
50
|
+
betas: ['files-api-2025-04-14'],
|
|
51
|
+
);
|
|
52
|
+
// Reference $file->id as a file content block on ->beta->messages->create().
|
|
53
|
+
```
|