Skip to content

Clarify run_script productive client return shape in docs#183

Merged
titouanmathis merged 1 commit into
mainfrom
feat/mcp-scripting-docs-shape
Jun 10, 2026
Merged

Clarify run_script productive client return shape in docs#183
titouanmathis merged 1 commit into
mainfrom
feat/mcp-scripting-docs-shape

Conversation

@titouanmathis

Copy link
Copy Markdown
Contributor

Small docs follow-up from live testing of the runner-backed run_script.

The injected productive client returns flattened records (read id, name, number directly, not JSON:API .type/.attributes) and list returns { data, meta } (e.g. meta.total_count). The scripting docs (surfaced by search_docs) now say so, and the example shows bounding large queries with { per_page: 50 } (a slow unbounded tasks.list({status:'open'}) was the one rough edge in testing).

Docs-only; no behavior change. 11 doc/search tests pass, npm run check clean.

🤖 Generated with Claude Code

Note in the scripting docs (served by search_docs) that the injected
productive client returns flattened records and that list returns
{ data, meta } — read field keys directly (id, name, number) rather than
JSON:API .type/.attributes, and bound large queries with opts like
{ per_page: 50 }.

Co-authored-by: Claude <claude@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@codecov

codecov Bot commented Jun 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.27%. Comparing base (4c8656f) to head (57d8719).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #183   +/-   ##
=======================================
  Coverage   97.27%   97.27%           
=======================================
  Files         266      266           
  Lines        8867     8867           
  Branches     2777     2787   +10     
=======================================
  Hits         8625     8625           
  Misses        236      236           
  Partials        6        6           
Flag Coverage Δ
unittests 97.27% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@titouanmathis titouanmathis merged commit 21b5d76 into main Jun 10, 2026
11 checks passed
@titouanmathis titouanmathis deleted the feat/mcp-scripting-docs-shape branch June 10, 2026 06:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant