Skip to content

Commit cc18585

Browse files
authored
docs: add docs for SecretResource (#104)
1 parent b1604ba commit cc18585

1 file changed

Lines changed: 33 additions & 1 deletion

File tree

src/deepset_mcp/api/README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The client automatically handles authentication, request management, and connect
2828

2929
## Core Resources
3030

31-
The SDK provides access to six main resources, each designed for specific aspects of the deepset platform:
31+
The SDK provides access to seven main resources, each designed for specific aspects of the deepset platform:
3232

3333
### Pipelines
3434

@@ -272,6 +272,37 @@ async with AsyncDeepsetClient() as client:
272272
print(f"Version: {installation.version}")
273273
```
274274

275+
### Secrets
276+
277+
Manage secrets for secure configuration and sensitive data:
278+
279+
```python
280+
from deepset_mcp.api.client import AsyncDeepsetClient
281+
282+
async with AsyncDeepsetClient() as client:
283+
secrets = client.secrets()
284+
285+
# List all secrets
286+
secret_list = await secrets.list(
287+
limit=20,
288+
field="created_at",
289+
order="DESC"
290+
)
291+
292+
# Create a new secret
293+
await secrets.create(
294+
name="api-key-secret",
295+
secret="your-secret-value"
296+
)
297+
298+
# Get a specific secret
299+
secret = await secrets.get("secret-id")
300+
print(f"Secret name: {secret.name}")
301+
302+
# Delete a secret
303+
await secrets.delete("secret-id")
304+
```
305+
275306
### Users
276307

277308
Access user information and manage user-related operations:
@@ -441,6 +472,7 @@ Main client class for API access.
441472
- `pipeline_templates(workspace: str)`: Returns PipelineTemplateResource for the specified workspace
442473
- `custom_components(workspace: str)`: Returns CustomComponentsResource for the specified workspace
443474
- `haystack_service()`: Returns HaystackServiceResource
475+
- `secrets()`: Returns SecretResource
444476
- `users()`: Returns UserResource
445477

446478
### Resource Classes

0 commit comments

Comments
 (0)