@ampcode/plugin 0.0.0-20260528003340-g17febba → 0.0.0-20260530003704-g2f9810c

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +18 -3
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -124,7 +124,12 @@ declare module '@ampcode/plugin' {
124
124
  * APIs under `PluginAPI.experimental` are not stable and may change or be removed.
125
125
  */
126
126
  export interface ExperimentalPluginAPI {
127
- /** Create a custom agent bound to this plugin runtime. */
127
+ /**
128
+ * Create a custom agent bound to this plugin runtime.
129
+ *
130
+ * Run `amp plugins show-agent-options` or `amp plugins show-agent-options --json` to
131
+ * discover public model IDs and built-in tool names that are suitable for plugin agents.
132
+ */
128
133
  createAgent(config: CreateAgentConfig): Agent
129
134
 
130
135
  /** Register a custom agent mode that clients may show alongside built-in modes. */
@@ -167,11 +172,21 @@ declare module '@ampcode/plugin' {
167
172
  export interface CreateAgentConfig {
168
173
  /** Optional stable identifier for logs, UI, and persisted run metadata. */
169
174
  name?: string
170
- /** Model identifier in `provider/model` format, such as `anthropic/claude-sonnet-4-6`. */
175
+ /**
176
+ * Model identifier in `provider/model` format, such as `anthropic/claude-sonnet-4-6`.
177
+ *
178
+ * Run `amp plugins show-agent-options --json` for the public model IDs intended for
179
+ * plugin agents.
180
+ */
171
181
  model: string
172
182
  /** Instructions appended to Amp's base agent prompt. */
173
183
  instructions: string
174
- /** Tools available to this agent. Use 'all' for all tools available in its runtime. */
184
+ /**
185
+ * Tools available to this agent. Use 'all' for all tools available in its runtime.
186
+ *
187
+ * Run `amp plugins show-agent-options --json` for built-in tool names intended for
188
+ * plugin agents.
189
+ */
175
190
  tools?: AgentToolSelection
176
191
  /** Optional reasoning effort override for models that support it. */
177
192
  reasoningEffort?: AgentReasoningEffort
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ampcode/plugin",
3
- "version": "0.0.0-20260528003340-g17febba",
3
+ "version": "0.0.0-20260530003704-g2f9810c",
4
4
  "description": "Amp Plugin API",
5
5
  "homepage": "https://ampcode.com/manual/plugin-api",
6
6
  "author": {