Skip to content

Commit a5b809c

Browse files
waleedlatif1waleedlatif1
authored
fix(docs): fixed naming semantics for memory tools, updated doc generator, & included docs for memory block (#389)
* added docs for memories * updated doc generator script to better find outputs * include google drive new tools in docs
1 parent 31ccaa5 commit a5b809c

File tree

21 files changed

+470
-109
lines changed

21 files changed

+470
-109
lines changed

‎apps/docs/content/docs/tools/github.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ Fetch PR details including diff and files changed
7070
| `blob_url` | string |
7171
| `raw_url` | string |
7272
| `status` | string |
73+
| `content` | string |
7374

7475
### `github_comment`
7576

@@ -103,6 +104,7 @@ Create comments on GitHub PRs
103104
| `line` | string |
104105
| `side` | string |
105106
| `commit_id` | string |
107+
| `content` | string |
106108

107109
### `github_repo_info`
108110

@@ -126,6 +128,7 @@ Retrieve comprehensive GitHub repository metadata including stars, forks, issues
126128
| `forks` | string |
127129
| `openIssues` | string |
128130
| `language` | string |
131+
| `content` | string |
129132

130133
### `github_latest_commit`
131134

@@ -150,6 +153,7 @@ Retrieve the latest commit from a GitHub repository
150153
| `author` | string |
151154
| `login` | string |
152155
| `avatar_url` | string |
156+
| `content` | string |
153157

154158
## Block Configuration
155159

‎apps/docs/content/docs/tools/google_docs.mdx‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,10 @@ Read content from a Google Docs document
9797

9898
#### Output
9999

100-
| Parameter | Type |
101-
| --------- | ------ |
102-
| `content` | string |
100+
| Parameter | Type |
101+
| ---------- | ------ |
102+
| `content` | string |
103+
| `metadata` | string |
103104

104105
### `google_docs_write`
105106

@@ -118,6 +119,7 @@ Write or update content in a Google Docs document
118119
| Parameter | Type |
119120
| ---------------- | ------ |
120121
| `updatedContent` | string |
122+
| `metadata` | string |
121123

122124
### `google_docs_create`
123125

‎apps/docs/content/docs/tools/google_drive.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Google Drive
3-
description: Create and list files
3+
description: Create, upload, and list files
44
---
55

66
import { BlockInfoCard } from '@/components/ui/block-info-card'

‎apps/docs/content/docs/tools/jina.mdx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,9 @@ Extract and process web content into clean, LLM-friendly text using Jina AI Read
7878

7979
#### Output
8080

81-
This tool does not produce any outputs.
81+
| Parameter | Type |
82+
| --------- | ------ |
83+
| `content` | string |
8284

8385
## Block Configuration
8486

‎apps/docs/content/docs/tools/mem0.mdx‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,9 +102,10 @@ Retrieve memories from Mem0 by ID or filter criteria
102102

103103
#### Output
104104

105-
| Parameter | Type |
106-
| --------- | ------ |
107-
| `data` | string |
105+
| Parameter | Type |
106+
| ---------- | ------ |
107+
| `memories` | string |
108+
| `ids` | string |
108109

109110
## Block Configuration
110111

‎apps/docs/content/docs/tools/memory.mdx‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
---
2+
title: Memory
3+
description: Add memory store
4+
---
5+
6+
import { BlockInfoCard } from '@/components/ui/block-info-card'
7+
8+
<BlockInfoCard
9+
type="memory"
10+
color="#F64F9E"
11+
icon={true}
12+
iconSvg={`<svg className="block-icon"
13+
14+
xmlns="http://www.w3.org/2000/svg"
15+
16+
17+
viewBox="0 0 24 24"
18+
fill="none"
19+
stroke="currentColor"
20+
strokeWidth="2"
21+
strokeLinecap="round"
22+
strokeLinejoin="round"
23+
>
24+
<path d="M12 5a3 3 0 1 0-5.997.125 4 4 0 0 0-2.526 5.77 4 4 0 0 0 .556 6.588A4 4 0 1 0 12 18Z" />
25+
<path d="M12 5a3 3 0 1 1 5.997.125 4 4 0 0 1 2.526 5.77 4 4 0 0 1-.556 6.588A4 4 0 1 1 12 18Z" />
26+
<path d="M15 13a4.5 4.5 0 0 1-3-4 4.5 4.5 0 0 1-3 4" />
27+
<path d="M17.599 6.5a3 3 0 0 0 .399-1.375" />
28+
<path d="M6.003 5.125A3 3 0 0 0 6.401 6.5" />
29+
<path d="M3.477 10.896a4 4 0 0 1 .585-.396" />
30+
<path d="M19.938 10.5a4 4 0 0 1 .585.396" />
31+
<path d="M6 18a4 4 0 0 1-1.967-.516" />
32+
<path d="M19.967 17.484A4 4 0 0 1 18 18" />
33+
</svg>`}
34+
/>
35+
36+
## Usage Instructions
37+
38+
Create persistent storage for data that needs to be accessed across multiple workflow steps. Store and retrieve information throughout your workflow execution to maintain context and state.
39+
40+
## Tools
41+
42+
### `memory_add`
43+
44+
Add a new memory to the database or append to existing memory with the same ID. When appending to existing memory, the memory types must match.
45+
46+
#### Input
47+
48+
| Parameter | Type | Required | Description |
49+
| --------- | ------ | -------- | -------------------------------------------------------------------------------------------------------- |
50+
| `id` | string | Yes | Identifier for the memory. If a memory with this ID already exists, the new data will be appended to it. |
51+
| `type` | string | Yes | Type of memory \(agent or raw\) |
52+
| `role` | string | No | Role for agent memory \(user, assistant, or system\) |
53+
| `content` | string | No | Content for agent memory |
54+
| `rawData` | json | No | Raw data to store \(JSON format\) |
55+
56+
#### Output
57+
58+
| Parameter | Type |
59+
| ---------- | ------ |
60+
| `memories` | string |
61+
62+
### `memory_get`
63+
64+
Retrieve a specific memory by its ID
65+
66+
#### Input
67+
68+
| Parameter | Type | Required | Description |
69+
| --------- | ------ | -------- | ------------------------------------- |
70+
| `id` | string | Yes | Identifier for the memory to retrieve |
71+
72+
#### Output
73+
74+
| Parameter | Type |
75+
| ---------- | ------ |
76+
| `memories` | string |
77+
| `message` | string |
78+
79+
### `memory_get_all`
80+
81+
Retrieve all memories from the database
82+
83+
#### Input
84+
85+
| Parameter | Type | Required | Description |
86+
| --------- | ---- | -------- | ----------- |
87+
88+
#### Output
89+
90+
| Parameter | Type |
91+
| ---------- | ------ |
92+
| `message` | string |
93+
| `memories` | string |
94+
95+
### `memory_delete`
96+
97+
Delete a specific memory by its ID
98+
99+
#### Input
100+
101+
| Parameter | Type | Required | Description |
102+
| --------- | ------ | -------- | ----------------------------------- |
103+
| `id` | string | Yes | Identifier for the memory to delete |
104+
105+
#### Output
106+
107+
| Parameter | Type |
108+
| --------- | ------ |
109+
| `message` | string |
110+
111+
## Block Configuration
112+
113+
### Input
114+
115+
| Parameter | Type | Required | Description |
116+
| ----------- | ------ | -------- | ----------- |
117+
| `operation` | string | Yes | Operation |
118+
119+
### Outputs
120+
121+
| Output | Type | Description |
122+
| ------------ | ------ | ------------------------ |
123+
| `response` | object | Output from response |
124+
| ↳ `memories` | any | memories of the response |
125+
| ↳ `id` | string | id of the response |
126+
127+
## Notes
128+
129+
- Category: `blocks`
130+
- Type: `memory`

‎apps/docs/content/docs/tools/meta.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
"jira",
2424
"linkup",
2525
"mem0",
26+
"memory",
2627
"notion",
2728
"openai",
2829
"perplexity",

‎apps/docs/content/docs/tools/pinecone.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,7 @@ Fetch vectors by ID from a Pinecone index
160160
| `values` | string |
161161
| `metadata` | string |
162162
| `score` | string |
163+
| `id` | string |
163164

164165
## Block Configuration
165166

‎apps/docs/content/docs/tools/reddit.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ Fetch the most popular (hot) posts from a specified subreddit.
6363
| Parameter | Type |
6464
| ----------- | ------ |
6565
| `subreddit` | string |
66+
| `posts` | string |
6667

6768
### `reddit_get_posts`
6869

@@ -82,6 +83,7 @@ Fetch posts from a subreddit with different sorting options
8283
| Parameter | Type |
8384
| ----------- | ------ |
8485
| `subreddit` | string |
86+
| `posts` | string |
8587

8688
### `reddit_get_comments`
8789

‎apps/docs/content/docs/tools/s3.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ Retrieve an object from an AWS S3 bucket
6969
| `size` | string |
7070
| `name` | string |
7171
| `lastModified` | string |
72+
| `url` | string |
7273

7374
## Block Configuration
7475

0 commit comments

Comments
 (0)