pocket-agent-sdk
v0.1.0
Published
Shared TypeScript types and JSON schemas for Pocket Agent services
Maintainers
Readme
Features
| Layer | Contents |
|-------|----------|
| TypeScript | ConnectionProfile, UserSetup, ApiResponse, SERVICE_IDS, auth helpers |
| JSON Schema | API envelopes, health/status, user-setup.yaml |
| Python | pocket_agent_sdk — Pydantic models, CONNECTION_PROFILES |
Requirements
- Node 20+ for TypeScript build
- Python 3.12+ for
pip install -e python
Install
npm install pocket-agent-sdkWorkspace sibling:
"dependencies": { "pocket-agent-sdk": "file:../pocket-agent-sdk" }cd python && pip install -e .Quick start
import type { ApiResponse, UserSetup } from 'pocket-agent-sdk';
import { SERVICE_IDS, CONNECTION_PROFILES } from 'pocket-agent-sdk';from pocket_agent_sdk import CONNECTION_PROFILES, SERVICE_IDS, UserSetupDevelopment
git clone https://github.com/pocket-agent/pocket-agent-sdk.git
cd pocket-agent-sdk
npm install && npm run checkFollow INSTRUCTIONS.md. In the org workspace, contracts are also described in specs/features/10-shared-contracts.md at the workspace root.
Documentation
| Doc | Description | |-----|-------------| | INSTRUCTIONS.md | SDK change process | | CHANGELOG.md | Release history | | CONTRIBUTING.md | Contributing |
Contributing
Contributions are welcome. Please read CONTRIBUTING.md before opening a pull request.
Security
To report a vulnerability, see SECURITY.md.
License
pocket-agent-sdk is released under the MIT License.
