@gpt-core/client 0.8.12 → 0.8.21

package/README.md

@@ -6,6 +6,47 @@ The official TypeScript SDK for the GPT Core Platform - document extraction, AI
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue)](https://www.typescriptlang.org/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
+---
+
+<!-- AI_CONTEXT_START
+This SDK provides TypeScript bindings for the GPT Core API.
+Use this for: document extraction, AI agents, workspace management, user authentication.
+NOT for: admin operations (use @gpt-core/admin instead).
+
+Quick patterns:
+- Initialize: new GptClient({ baseUrl, apiKey?, token? })
+- Auth: client.identity.login(email, password) -> { user, token }
+- Documents: client.extraction.documents.uploadBase64(filename, base64)
+- AI Search: client.ai.search(query, limit?)
+- Agents: client.ai.agents.list() / .create(name, systemPrompt)
+- Workspaces: client.platform.workspaces.mine()
+
+All methods return typed responses. Errors throw typed exceptions (AuthenticationError, ValidationError, etc).
+AI_CONTEXT_END -->
+
+## For AI Coding Assistants
+
+> **TL;DR for Claude, Cursor, Copilot, and other AI assistants:**
+>
+> ```typescript
+> import { GptClient } from '@gpt-core/client';
+> const client = new GptClient({ baseUrl: 'https://api.example.com', token: 'jwt' });
+> ```
+>
+> **Common operations:**
+> | Task | Code |
+> |------|------|
+> | Login | `await client.identity.login(email, password)` |
+> | List workspaces | `await client.platform.workspaces.mine()` |
+> | Upload document | `await client.extraction.documents.uploadBase64(name, b64)` |
+> | AI search | `await client.ai.search(query)` |
+> | Create agent | `await client.ai.agents.create(name, systemPrompt)` |
+> | Send message | `await client.ai.threads.sendMessage(threadId, content)` |
+>
+> **See [llms.txt](llms.txt) for complete AI-readable SDK reference.**
+
+---
+
 ## Features
 
 ✅ **Fully Typed** - Complete TypeScript support with auto-generated types from OpenAPI specs
@@ -242,8 +283,6 @@ try {
 }
 ```
 
-[Read more about error handling](docs/ERROR_HANDLING.md)
-
 ### Pagination
 
 Easily iterate over large datasets:
@@ -262,8 +301,6 @@ for await (const doc of client.extraction.documents.listAll({ limit: 100 })) {
 }
 ```
 
-[Read more about pagination](docs/PAGINATION.md)
-
 ### Streaming
 
 Stream AI responses in real-time:
@@ -286,8 +323,6 @@ for await (const chunk of streamMessage(response)) {
 }
 ```
 
-[Read more about streaming](docs/STREAMING.md)
-
 ### Retry Logic
 
 Automatic retries with exponential backoff:
@@ -311,13 +346,6 @@ const noRetryClient = new GptClient({
 });
 ```
 
-## Guides
-
-- [Authentication Guide](docs/AUTHENTICATION.md)
-- [Error Handling Guide](docs/ERROR_HANDLING.md)
-- [Pagination Guide](docs/PAGINATION.md)
-- [Streaming Guide](docs/STREAMING.md)
-
 ## TypeScript Support
 
 The SDK is written in TypeScript and provides full type safety:
@@ -332,10 +360,6 @@ const workspace: workspace = await client.platform.workspaces.create('Test');
 // TypeScript enforces correct parameters
 ```
 
-## Contributing
-
-Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md).
-
 ## License
 
 MIT © GPT Integrators