Feat/subset of input schema #210

MichalKalita · 2025-08-06T16:26:47Z

closes #184

jirispilka · 2025-08-07T09:21:41Z

@MichalKalita please ask for review only once it is ready for a review.

For example, I'm getting bunch of errors when running npm run build

npm run build                   

> @apify/[email protected] build
> tsc -b src

src/main.ts:59:68 - error TS2345: Argument of type '{}' is not assignable to parameter of type 'Record<string, unknown>'.
  Index signature for type 'string' is missing in type '{}'.

59     const { items } = await callActorGetDataset(input.debugActor!, input.debugActorInput!, process.env.APIFY_TOKEN, options);
                                                                      ~~~~~~~~~~~~~~~~~~~~~~

src/tools/actor.ts:13:5 - error TS2305: Module '"../const.js"' has no exported member 'ADVANCED_INPUT_KEY'.

13     ADVANCED_INPUT_KEY,
       ~~~~~~~~~~~~~~~~~~

src/tools/actor.ts:66:19 - error TS2698: Spread types may only be created from object types.

66         input = { ...advancedInput, ...rest };
                     ~~~~~~~~~~~~~~~~

src/tools/build.ts:9:35 - error TS2305: Module '"../const.js"' has no exported member 'ADVANCED_INPUT_KEY'.

9 import { ACTOR_README_MAX_LENGTH, ADVANCED_INPUT_KEY, HelperTools } from '../const.js';
                                    ~~~~~~~~~~~~~~~~~~

src/utils/tools.ts:1:10 - error TS2305: Module '"../const.js"' has no exported member 'ADVANCED_INPUT_KEY'.

1 import { ADVANCED_INPUT_KEY } from '../const.js';
           ~~~~~~~~~~~~~~~~~~

MichalKalita · 2025-08-07T09:30:31Z

@jirispilka It's some kind of mistake. I haven't asked for review yet. This pull request is a draft.

jirispilka · 2025-08-07T09:34:32Z

@jirispilka It's some kind of mistake. I haven't asked for review yet. This pull request is a draft.

ok, no problem :) . I was just eager to check and then a bit disappointed that it is not working

- Introduced `McpOptions` type for input parameters. - Replaced the previous input processing logic with Zod schema validation for better type safety and clarity. - Updated related functions and types to align with the new schema. - Added a new constant `ADVANCED_INPUT_KEY` in `const.ts` for future use.

…t-schema

MQ37

Went through it and I like the refactored and simplified parts - mainly the ToolEntry type. There is couple of nits and one important question regarding the caching that needs clarification before merging.

Note: Please also be sure to document this in docs.apify.com and this repo README.md.

MQ37 · 2025-08-11T12:47:09Z

tests/integration/suite.ts

-            expectToolNamesToContain(names, actors.map((actor) => actorNameToToolName(actor)));
+            expect(names).toMatchInlineSnapshot(`
+              [
+                "get-actor-details",


If we change the tool names we need to update the test, this is fragile, I prefer the previous logic - it was not nice but was definitely more robust.

I have a problem with this tests when I worked on this issue. Tests failed and I don't know why. This test is really simple and if fails, is easy to find where is a problem, what missing and what should not be here.

All snapshots can be updated using the command npx vitest tests --update.

I don't like this added complexity. But if you are both @jirispilka and @MichalKalita for using this then I am fine with keeping that.

src/tools/actor.ts

src/utils/tools.ts

src/stdio.ts

tests/integration/suite.ts

src/types.ts

src/tools/actor.ts

src/tools/utils.ts

jirispilka · 2025-08-12T08:15:41Z

src/tools/actor.ts

            const schemaID = getToolSchemaID(actorDefinitionPruned.actorFullName);
            if (actorDefinitionPruned.input && 'properties' in actorDefinitionPruned.input && actorDefinitionPruned.input) {
-                actorDefinitionPruned.input.properties = transformActorInputSchemaProperties(actorDefinitionPruned.input);
+                actorDefinitionPruned.input.properties = transformActorInputSchemaProperties(


Minor comment—no need to fix now, maybe later.
We currently have three things there: basic, full, and pruned (though “pruned” is a bit misleading). I know it’s a modified schema based on some transformation, but it could also be a schema without advancedInput.

jirispilka

(somehow IDE crashed when submitting the review)

I like it.

But apart from the comments from MQ and my own comments, IMO we’re missing some functionality.

When fullSchema is false, the LLM doesn’t know there are advanced parameters available.

I think we discussed the following flow:

Provide the basic schema, but include the advanced attributes in the description.
Let the LLM know that other attributes exist and that it can fetch the full schema to call an Actor with them.
Essentially, the LLM would first do get-schema and then call-actor. This is inefficient, but it would solve some cases.

And the assumption was that:

90% use-cases are solved with basic schema
10% use-cases, either you opt for fullSchema or you will do get-schema and call-actor (yes, you need to have this feature enabled)

jirispilka · 2025-08-12T08:22:49Z

One more thing, we should document it in the README (query parameter + description)

And we'll need to include it in docs.apify.com, and mcp-apify-server (but that's for later)

MichalKalita · 2025-08-22T12:45:18Z

Closing this PR, more details in #184 (comment)

MichalKalita added 3 commits August 5, 2025 18:19

feat: separate advanced attributes in schema

a31981c

feat: list tools ignore additional inputs details

d497f1f

feat: call actor with expanded advanced input like normal input

b26b883

MichalKalita added 8 commits August 8, 2025 00:29

refactor: update ActorsMcpServer to accept McpOptions

dd57ea6

fix: unit tests

0333abb

fix: integration tests

ea90ae2

fix: stdio integration tests

d1fe5a5

fix: tests

227823f

fix: modify schema after cache

3014adf

Merge remote-tracking branch 'origin/master' into feat/subset-of-inpu…

6c04595

…t-schema

github-actions bot assigned MichalKalita Aug 11, 2025

github-actions bot added t-ai Issues owned by the AI team. tested Temporary label used only programatically for some analytics. labels Aug 11, 2025

MichalKalita added 2 commits August 11, 2025 12:36

revert all not required code to finish issue

34cac76

fix: tool get-actor-detail returns schema with advanced inputs

04f4ac2

MichalKalita marked this pull request as ready for review August 11, 2025 12:09

MichalKalita requested review from MQ37 and jirispilka August 11, 2025 12:10

MQ37 requested changes Aug 11, 2025

View reviewed changes

jirispilka requested changes Aug 12, 2025

View reviewed changes

MichalKalita added 4 commits August 12, 2025 10:25

fix: implement code review feedback

e3af744

fix: code review improvements

2b6314b

fix: code review improvements

78ca98d

fix: code review improvements

900477f

MichalKalita added 2 commits August 12, 2025 14:53

fix: update readme

467ae72

fix: tests

acfca40

MichalKalita requested review from MQ37 and jirispilka August 12, 2025 12:58

MichalKalita closed this Aug 22, 2025

Feat/subset of input schema #210

Feat/subset of input schema #210

Uh oh!

Conversation

MichalKalita commented Aug 6, 2025

Uh oh!

jirispilka commented Aug 7, 2025

Uh oh!

MichalKalita commented Aug 7, 2025

Uh oh!

jirispilka commented Aug 7, 2025

Uh oh!

MQ37 left a comment

Choose a reason for hiding this comment

Uh oh!

MQ37 Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

MichalKalita Aug 12, 2025

Choose a reason for hiding this comment

Uh oh!

MichalKalita Aug 12, 2025

Choose a reason for hiding this comment

Uh oh!

MQ37 Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jirispilka Aug 12, 2025

Choose a reason for hiding this comment

Uh oh!

jirispilka left a comment

Choose a reason for hiding this comment

Uh oh!

jirispilka commented Aug 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MichalKalita commented Aug 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jirispilka commented Aug 12, 2025 •

edited

Loading