Public: anyone can read this; the crew can change it.

Every MCP tool's doc names each argument its inputSchema takes, and a test refuses a tool whose doc leaves one out #9119

Parked opened this
Closed without merging

Each of the 16 tools now names every argument its inputSchema takes in its doc, and a new test fails when one is left out. bun test on the 26 files fast.ts names, test/mcp-size.test.ts and the other test/mcp.test.ts files all pass, and gate.ts and tsc --noEmit are clean.

Notes

stopped parked by the crew deploy 01ad573

opened this

Each of the 16 tools now names every argument its inputSchema takes in its doc, and a new test fails when one is left out. bun test on the 26 files fast.ts names, test/mcp-size.test.ts and the other test/mcp*.test.ts files all pass, and gate.ts and tsc --noEmit are clean. I did not run the full suite; the forge runs that on the push.

  • Docs: each of the 16 tools' docs now starts with the house form, { a, b? }, with ? on the optional arguments, followed by the existing text. Behaviour is unchanged.
  • Two extra tools: stop (run) and take_updates (repo) also left an argument out, though the issue didn't list them. The test failed on them, so I fixed both the same way.
  • Test: test/mcp-doc-names-every-argument.test.ts reads TOOLS and checks every inputSchema property against the backticked text of the tool's doc. A breach fails with a line like "doc of stop omits argument run".
  • Owed set: following.repo and follow_mode.mode are held until #9109 lands. A second test goes red if an owed argument no longer breaches, so the set can only shrink.
  • Snapshots: no MCP contract snapshot pins these docs, so none changed.
  • Left alone: following, follow_mode and their family, as the issue asks.

To try it, run bun test test/mcp-doc-names-every-argument.test.ts test/mcp-size.test.ts.

Closes #9110

3 earlier comments
commented

Each of the 16 tools now names every argument its inputSchema takes in its doc, and a new test fails when one is left out. bun test on the 26 files fast.ts names, test/mcp-size.test.ts and the other test/mcp*.test.ts files all pass, and gate.ts and tsc --noEmit are clean. I did not run the full suite; the forge runs that on the push.

  • Docs: each of the 16 tools' docs now starts with the house form, { a, b? }, with ? on the optional arguments, followed by the existing text. Behaviour is unchanged.
  • Two extra tools: stop (run) and take_updates (repo) also left an argument out, though the issue didn't list them. The test failed on them, so I fixed both the same way.
  • Test: test/mcp-doc-names-every-argument.test.ts reads TOOLS and checks every inputSchema property against the backticked text of the tool's doc. A breach fails with a line like "doc of stop omits argument run".
  • Owed set: following.repo and follow_mode.mode are held until #9109 lands. A second test goes red if an owed argument no longer breaches, so the set can only shrink.
  • Snapshots: no MCP contract snapshot pins these docs, so none changed.
  • Left alone: following, follow_mode and their family, as the issue asks.

To try it, run bun test test/mcp-doc-names-every-argument.test.ts test/mcp-size.test.ts.

commented

I made no change for this. The preview deploy itself didn't fail, and I don't think the cause is in my diff.

The log you pasted shows ready:, serving https://lab--9119--forge-trevato-apps.open-platform.sh and done:. The app booted, so the "failed" verdict comes from "no tests declared, none run". forge.json has no app.test entry. It declares its tests under check (fast, run and verify), and the forge runs those on every push. I didn't touch forge.json; the last commit that did was #8892.

The tests that cover my change pass locally. I ran 26 test files, the test/mcp*.test.ts files and test/mcp-size.test.ts, plus gate.ts and tsc --noEmit. I haven't seen the forge's check verdict on this push yet. If it comes back red, that log will say what to fix.

I didn't add a test entry to forge.json. I think that choice belongs to a person, because it would make every preview deploy run the suite.

commented

Each MCP tool's description now names every argument its inputSchema takes. A test refuses a tool whose doc leaves one out.

The check failed because no commit message had a Try: line. I added an empty commit with one and pushed it. The code is unchanged from the earlier push.

bun scripts/gate.ts printed nothing and the push went through. I did not re-run the type check or the tests, since nothing in the tree changed.

Try: call tools/list on https://lab--9119--forge-trevato-apps.open-platform.sh/mcp and read each tool's description for its arguments.

I chose not to rewrite the earlier commit, because that would need a force push, which is refused.

🤖 Generated with Claude Code

commented

Parked by the crew: the check stayed red through 2 automatic tries

Sign in to join this conversation.

↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs