Skip to content

Commit 01ecfeb

Browse files
committed
refactor: Clean up code formatting and enhance documentation
- Reformatted the LICENSE file for improved readability by adjusting line breaks. - Updated README.md to enhance clarity and structure, including better formatting of sections and descriptions. - Ensured consistent use of quotation marks and spacing in TypeScript files, particularly in src/index.ts and src/db/client.ts. - Added missing newlines at the end of several files, including package.json and renovate.json, to adhere to coding standards. - Improved the GitHub Actions workflow file by removing unnecessary whitespace for cleaner code. - Maintained existing functionality while enhancing code readability and documentation clarity.
1 parent d13213c commit 01ecfeb

File tree

11 files changed

+389
-344
lines changed

11 files changed

+389
-344
lines changed

.github/workflows/publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
runs-on: ubuntu-latest
1212
steps:
1313
- uses: actions/checkout@v4
14-
14+
1515
- uses: pnpm/action-setup@v2
1616
with:
1717
version: 9
@@ -22,7 +22,7 @@ jobs:
2222
cache: 'pnpm'
2323

2424
- run: pnpm install
25-
25+
2626
- name: Create Release Pull Request or Publish
2727
id: changesets
2828
uses: changesets/action@v1

.prettierignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Package Managers
2+
package-lock.json
3+
pnpm-lock.yaml
4+
yarn.lock

.prettierrc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"useTabs": true,
3+
"singleQuote": true,
4+
"trailingComma": "all",
5+
"printWidth": 70,
6+
"proseWrap": "always"
7+
}

LICENSE

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,21 @@ MIT License
22

33
Copyright (c) 2025 Scott Spence
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
5+
Permission is hereby granted, free of charge, to any person obtaining
6+
a copy of this software and associated documentation files (the
7+
"Software"), to deal in the Software without restriction, including
8+
without limitation the rights to use, copy, modify, merge, publish,
9+
distribute, sublicense, and/or sell copies of the Software, and to
10+
permit persons to whom the Software is furnished to do so, subject to
11+
the following conditions:
1112

12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
13+
The above copyright notice and this permission notice shall be
14+
included in all copies or substantial portions of the Software.
1415

15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
[![smithery badge](https://smithery.ai/badge/mcp-memory-libsql)](https://smithery.ai/server/mcp-memory-libsql)
44

5-
A high-performance, persistent memory system for the Model Context Protocol (MCP) powered by libSQL. This server provides vector search capabilities and efficient knowledge storage using libSQL as the backing store.
5+
A high-performance, persistent memory system for the Model Context
6+
Protocol (MCP) powered by libSQL. This server provides vector search
7+
capabilities and efficient knowledge storage using libSQL as the
8+
backing store.
69

710
<a href="https://glama.ai/mcp/servers/22lg4lq768">
811
<img width="380" height="200" src="https://glama.ai/mcp/servers/22lg4lq768/badge" alt="Glama badge" />
@@ -19,7 +22,8 @@ A high-performance, persistent memory system for the Model Context Protocol (MCP
1922

2023
## Configuration
2124

22-
This server is designed to be used as part of an MCP configuration. Here are examples for different environments:
25+
This server is designed to be used as part of an MCP configuration.
26+
Here are examples for different environments:
2327

2428
### Cline Configuration
2529

@@ -41,7 +45,9 @@ Add this to your Cline MCP settings:
4145

4246
### Claude Desktop with WSL Configuration
4347

44-
For a detailed guide on setting up this server with Claude Desktop in WSL, see [Getting MCP Server Working with Claude Desktop in WSL](https://scottspence.com/posts/getting-mcp-server-working-with-claude-desktop-in-wsl).
48+
For a detailed guide on setting up this server with Claude Desktop in
49+
WSL, see
50+
[Getting MCP Server Working with Claude Desktop in WSL](https://scottspence.com/posts/getting-mcp-server-working-with-claude-desktop-in-wsl).
4551

4652
Add this to your Claude Desktop configuration for WSL environments:
4753

@@ -62,7 +68,8 @@ Add this to your Claude Desktop configuration for WSL environments:
6268

6369
### Database Configuration
6470

65-
The server supports both local SQLite and remote libSQL databases through the LIBSQL_URL environment variable:
71+
The server supports both local SQLite and remote libSQL databases
72+
through the LIBSQL_URL environment variable:
6673

6774
For local SQLite databases:
6875

@@ -85,13 +92,17 @@ For remote libSQL databases (e.g., Turso):
8592
}
8693
```
8794

88-
Note: When using WSL, ensure the database path uses the Linux filesystem format (e.g., `/home/username/...`) rather than Windows format.
95+
Note: When using WSL, ensure the database path uses the Linux
96+
filesystem format (e.g., `/home/username/...`) rather than Windows
97+
format.
8998

90-
By default, if no URL is provided, it will use `file:/memory-tool.db` in the current directory.
99+
By default, if no URL is provided, it will use `file:/memory-tool.db`
100+
in the current directory.
91101

92102
## API
93103

94-
The server implements the standard MCP memory interface with additional vector search capabilities:
104+
The server implements the standard MCP memory interface with
105+
additional vector search capabilities:
95106

96107
- Entity Management
97108
- Create/Update entities with embeddings
@@ -108,7 +119,8 @@ The server uses a libSQL database with the following schema:
108119

109120
- Entities table: Stores entity information and embeddings
110121
- Relations table: Stores relationships between entities
111-
- Vector search capabilities implemented using libSQL's built-in vector operations
122+
- Vector search capabilities implemented using libSQL's built-in
123+
vector operations
112124

113125
## Development
114126

@@ -136,13 +148,15 @@ pnpm release
136148

137149
## Contributing
138150

139-
Contributions are welcome! Please read our contributing guidelines before submitting pull requests.
151+
Contributions are welcome! Please read our contributing guidelines
152+
before submitting pull requests.
140153

141154
## License
142155

143156
MIT License - see the [LICENSE](LICENSE) file for details.
144157

145158
## Acknowledgments
146159

147-
- Built on the [Model Context Protocol](https://github.com/modelcontextprotocol)
160+
- Built on the
161+
[Model Context Protocol](https://github.com/modelcontextprotocol)
148162
- Powered by [libSQL](https://github.com/tursodatabase/libsql)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,4 +60,4 @@
6060
"volta": {
6161
"node": "22.13.0"
6262
}
63-
}
63+
}

renovate.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
"extends": [
44
"config:recommended"
55
]
6-
}
6+
}

0 commit comments

Comments
 (0)