Skip to content

docs: rewrite README around usage - #6

Merged
TheGreatAxios merged 1 commit into
cl-9042-google-tools-replace-conditional-spread-in-sidecar-bundlefrom
cl-9029-google-tools-replace-stale-github-install-line-with-npm-add
Sep 27, 2026
Merged

TheGreatAxios merged 1 commit into
cl-9042-google-tools-replace-conditional-spread-in-sidecar-bundlefrom
cl-9029-google-tools-replace-stale-github-install-line-with-npm-add

Conversation

@TheGreatAxios

@TheGreatAxios TheGreatAxios commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Opener describes Gmail tools for AI agents and states that only Gmail is covered.
  • Install is bun add @corbits/google-tools @intx/agent @intx/types; no github: references remain.
  • Quickstart attaches the gmail sidecar-bundle tools to an agent with defineAgent; the sidecar supplies the granted gmail-api credential.
  • Tool reference table, and an Approvals section: every tool asks, and always-allow saves a grant.
  • Interchange section covers the ./sidecar-bundle export and the interchange.tools / gmail-api credential manifest entries.
  • Development and live Gmail docs move to CONTRIBUTING.md.

Stacked on #5. Merge order: #4, #5, #6, #8.

Verification

  • README quickstart typechecked against the built dist/.
  • bun run typecheck, bun run test, bun run build pass. Live Gmail checks not run.

Closes CL-9029
Closes CL-9037
Closes CL-9035
Closes CL-9032
Closes CL-9033
Closes CL-9038
Closes CL-9047

@TheGreatAxios
TheGreatAxios force-pushed the cl-9029-google-tools-replace-stale-github-install-line-with-npm-add branch from 6e35b55 to a59b59a Compare September 25, 2026 13:50
@TheGreatAxios
TheGreatAxios force-pushed the cl-9029-google-tools-replace-stale-github-install-line-with-npm-add branch 4 times, most recently from 74302ef to b51c579 Compare September 25, 2026 22:44
@TheGreatAxios
TheGreatAxios force-pushed the cl-9029-google-tools-replace-stale-github-install-line-with-npm-add branch from b51c579 to 617b8fa Compare September 25, 2026 23:58
@TheGreatAxios
TheGreatAxios force-pushed the cl-9029-google-tools-replace-stale-github-install-line-with-npm-add branch from 617b8fa to d01ee0a Compare September 26, 2026 00:32
@TheGreatAxios
TheGreatAxios force-pushed the cl-9029-google-tools-replace-stale-github-install-line-with-npm-add branch from 9a75496 to ad97fd4 Compare September 26, 2026 00:57
State that Gmail is the only supported API, install the package and its
peers with bun, and add a quickstart that attaches the gmail tools to an
agent, a tool reference with approval gates, and the sidecar-bundle and
interchange manifest entries. Development and live Gmail checks move to
CONTRIBUTING.md.
@TheGreatAxios
TheGreatAxios force-pushed the cl-9029-google-tools-replace-stale-github-install-line-with-npm-add branch from ad97fd4 to 64f9ad1 Compare September 26, 2026 01:27
@TheGreatAxios TheGreatAxios changed the title Rewrite README around usage docs: rewrite README around usage Sep 26, 2026
@TheGreatAxios
TheGreatAxios added this pull request to stack #9 September 26, 2026 01:58
@TheGreatAxios
TheGreatAxios merged commit f36a541 into main Sep 27, 2026
2 checks passed
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