Skip to content

Commit 73f6ee9

Browse files
nguyenhuy-eaea-open-source
nguyenhuy-ea
authored and
ea-open-source
committed
init project
0 parents  commit 73f6ee9

File tree

9 files changed

+720
-0
lines changed

9 files changed

+720
-0
lines changed

‎.env.example‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
REMEMBERIZER_API_TOKEN=

‎.gitignore‎

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# UV
98+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
#uv.lock
102+
103+
# poetry
104+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105+
# This is especially recommended for binary packages to ensure reproducibility, and is more
106+
# commonly ignored for libraries.
107+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108+
#poetry.lock
109+
110+
# pdm
111+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
112+
#pdm.lock
113+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
114+
# in version control.
115+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
116+
.pdm.toml
117+
.pdm-python
118+
.pdm-build/
119+
120+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
121+
__pypackages__/
122+
123+
# Celery stuff
124+
celerybeat-schedule
125+
celerybeat.pid
126+
127+
# SageMath parsed files
128+
*.sage.py
129+
130+
# Environments
131+
.env
132+
.venv
133+
env/
134+
venv/
135+
ENV/
136+
env.bak/
137+
venv.bak/
138+
139+
# Spyder project settings
140+
.spyderproject
141+
.spyproject
142+
143+
# Rope project settings
144+
.ropeproject
145+
146+
# mkdocs documentation
147+
/site
148+
149+
# mypy
150+
.mypy_cache/
151+
.dmypy.json
152+
dmypy.json
153+
154+
# Pyre type checker
155+
.pyre/
156+
157+
# pytype static type analyzer
158+
.pytype/
159+
160+
# Cython debug symbols
161+
cython_debug/
162+
163+
# PyCharm
164+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
165+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
166+
# and can be added to the global gitignore or merged into this file. For a more nuclear
167+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
168+
#.idea/

‎.pre-commit-config.yaml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
default_stages: [commit]
2+
3+
repos:
4+
- repo: https://github.com/pre-commit/pre-commit-hooks
5+
rev: v4.5.0
6+
hooks:
7+
- id: trailing-whitespace
8+
- id: end-of-file-fixer
9+
- id: check-json
10+
- id: check-toml
11+
- id: check-xml
12+
- id: debug-statements
13+
- id: check-builtin-literals
14+
- id: check-case-conflict
15+
- id: check-docstring-first
16+
- id: detect-private-key
17+
exclude: .cert/
18+
19+
- repo: https://github.com/asottile/pyupgrade
20+
rev: v3.15.0
21+
hooks:
22+
- id: pyupgrade
23+
args: [--py311-plus]
24+
25+
- repo: https://github.com/psf/black
26+
rev: 24.10.0
27+
hooks:
28+
- id: black
29+
language_version: python3
30+
31+
- repo: https://github.com/PyCQA/isort
32+
rev: 5.13.2
33+
hooks:
34+
- id: isort
35+
language_version: python3
36+
37+
- repo: https://github.com/PyCQA/flake8
38+
rev: 6.1.0
39+
hooks:
40+
- id: flake8
41+
args: [--max-line-length=120]

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Anthropic, PBC
4+
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:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
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.

‎README.md‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
# MCP Get Community Servers
2+
3+
A [Model Context Protocol](https://www.anthropic.com/news/model-context-protocol) server for interacting with Rememberizer's document and knowledge management API. This server enables Large Language Models to search, retrieve, and manage documents and integrations through Rememberizer.
4+
5+
Please note that `mcp-server-rememberizer` is currently in development and the functionality may be subject to change.
6+
7+
## Components
8+
9+
### Resources
10+
11+
The server provides access to two types of resources: Documents or Slack discussions
12+
13+
### Tools
14+
15+
1. `rememberizer_search`
16+
17+
- Search for documents by semantic similarity
18+
- Input:
19+
- `q` (string): Up to a 400-word sentence to find semantically similar chunks of knowledge
20+
- `n` (integer, optional): Number of similar documents to return (default: 5)
21+
- `from` (string, optional): Start date in ISO 8601 format with timezone (e.g., 2023-01-01T00:00:00Z). Use this to filter results from a specific date (default: None)
22+
- `to` (string, optional): End date in ISO 8601 format with timezone (e.g., 2024-01-01T00:00:00Z). Use this to filter results until a specific date (default: None)
23+
- Returns: Search results as text output
24+
25+
2. `rememberizer_agentic_search`
26+
27+
- Search for documents by semantic similarity with LLM Agents augmentation
28+
- Input:
29+
- `query` (string): Up to a 400-word sentence to find semantically similar chunks of knowledge. This query can be augmented by our LLM Agents for better results.
30+
- `n_chunks` (integer, optional): Number of similar documents to return (default: 5)
31+
- `user_context` (string, optional): The additional context for the query. You might need to summarize the conversation up to this point for better context-awared results (default: None)
32+
- `from` (string, optional): Start date in ISO 8601 format with timezone (e.g., 2023-01-01T00:00:00Z). Use this to filter results from a specific date (default: None)
33+
- `to` (string, optional): End date in ISO 8601 format with timezone (e.g., 2024-01-01T00:00:00Z). Use this to filter results until a specific date (default: None)
34+
- Returns: Search results as text output
35+
36+
3. `rememberizer_list_integrations`
37+
38+
- List available data source integrations
39+
- Input: None required
40+
- Returns: List of available integrations
41+
42+
4. `rememberizer_account_information`
43+
44+
- Get account information
45+
- Input: None required
46+
- Returns: Account information details
47+
48+
5. `rememberizer_list_documents`
49+
50+
- Retrieves a paginated list of all documents
51+
- Input:
52+
- `page` (integer, optional): Page number for pagination, starts at 1 (default: 1)
53+
- `page_size` (integer, optional): Number of documents per page, range 1-1000 (default: 100)
54+
- Returns: List of documents
55+
56+
## Installation
57+
58+
### Using uv (recommended)
59+
60+
When using [`uv`](https://docs.astral.sh/uv/), no specific installation is needed. Use [`uvx`](https://docs.astral.sh/uv/guides/tools/) to directly run _mcp-server-rememberizer_.
61+
62+
## Configuration
63+
64+
### Environment Variables
65+
66+
The following environment variables are required:
67+
68+
- `REMEMBERIZER_API_TOKEN`: Your Rememberizer API token
69+
70+
You can register an API key by create your own [Common Knowledge in Rememberizer](https://docs.rememberizer.ai/developer/registering-and-using-api-keys).
71+
72+
### Usage with Claude Desktop
73+
74+
Add this to your `claude_desktop_config.json`:
75+
76+
```json
77+
"mcpServers": {
78+
"rememberizer": {
79+
"command": "uv",
80+
"args": [
81+
"--directory",
82+
"/path/to/directory/mcp-servers-rememberizer/src/mcp_server_rememberizer",
83+
"run",
84+
"mcp-server-rememberizer"
85+
],
86+
"env": {
87+
"REMEMBERIZER_API_TOKEN": "your-rememberizer-api-token",
88+
}
89+
}
90+
}
91+
```
92+
93+
## Debugging
94+
95+
Since MCP servers run over stdio, debugging can be challenging. For the best debugging
96+
experience, we strongly recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).
97+
98+
You can launch the MCP Inspector via [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) with this command:
99+
100+
```bash
101+
npx @modelcontextprotocol/inspector uv --directory /path/to/directory/mcp-servers-rememberizer/src/mcp_server_rememberizer run mcp-server-rememberizer
102+
```
103+
104+
Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.
105+
106+
## License
107+
108+
This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.

‎pyproject.toml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
[project]
2+
name = "mcp-server-rememberizer"
3+
version = "0.1.0"
4+
description = "A Model Context Protocol server for interacting with Rememberizer's document and knowledge management API. This server enables Large Language Models to search, retrieve, and manage documents and integrations through Rememberizer."
5+
readme = "README.md"
6+
requires-python = ">=3.11"
7+
dependencies = [
8+
"httpx>=0.27.2",
9+
"mcp>=1.0.0",
10+
"python-dotenv>=1.0.1",
11+
]
12+
[[project.authors]]
13+
name = "Rememberizer"
14+
email = "support@rememberizer.ai"
15+
16+
[build-system]
17+
requires = [ "hatchling",]
18+
build-backend = "hatchling.build"
19+
20+
[dependency-groups]
21+
dev = [
22+
"pyright>=1.1.389",
23+
]
24+
25+
[project.scripts]
26+
mcp-server-rememberizer = "mcp_server_rememberizer:main"
27+
28+
# ==== isort ====
29+
[tool.isort]
30+
profile = "black"
31+
line_length = 118

‎src/mcp_server_rememberizer/__init__.py‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import asyncio
2+
3+
from . import server
4+
5+
6+
def main():
7+
"""Main entry point for the package."""
8+
asyncio.run(server.main())
9+
10+
11+
__all__ = ["main", "server"]

0 commit comments

Comments
 (0)