| Name | ai-filesystem JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | None |
| Summary | Virtual filesystem service for AI agents with LangChain integration |
| upload_time | 2025-08-01 01:21:08 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | MIT |
| keywords |
langchain
ai
filesystem
agents
tools
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# AI Filesystem
A virtual filesystem API for AI agents. Users can easily provide their agents with siloed filesystems to use as long term memory, scratchpads, or general purpose storage.
## How It Works
1. **API Server**: FastAPI backend that stores files in PostgreSQL
2. **User Isolation**: Each user can only see/modify their own files (enforced by database)
3. **Multiple Filesystems**: A user can have multiple filesystems and provide their agents with access to different, or the same filesystems.
## [Beta] Quick Start
### Creating an account on the Filesystem
1. Navigate [here](https://auth.fs.langchain.com) and sign up for an account on the Filesystem.
2. Create an API key and save it someplace secure!
### Giving your agent access to the Filesystem
1. Set your API key as an environment variable for your agent: `AGENT_FS_API_KEY=<api_key>`
2. Specify the URL for the filesystem. If you're using our hosted solution, it is `AGENT_FS_URL=agent-file-system-production.up.railway.app`
3. Instantiate the filesystem client, and give your agent access to the tools
```python
from ai_filesystem import FilesystemClient
client = FilesystemClient(
filesystem="nicks-agent-filesystem"
)
filesystem_tools = client.create_tools() # list files, read file, create new file, and edit file
agent.bind_tools(filesystem_tools)
```
3. In your agent's system prompt, make sure to specify how you want the agent to use the filesystem. Common use cases include as long-term memory, to store learnings and mistakes, or to save work products.
Raw data
{
"_id": null,
"home_page": null,
"name": "ai-filesystem",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "langchain, ai, filesystem, agents, tools",
"author": null,
"author_email": "Nick <nick@langchain.dev>",
"download_url": "https://files.pythonhosted.org/packages/3e/5b/e6724e897339f47f75f11c59d98c4ea7bd4eba3a89ff1494e96037e1cb7e/ai_filesystem-0.1.3.tar.gz",
"platform": null,
"description": "# AI Filesystem\n\nA virtual filesystem API for AI agents. Users can easily provide their agents with siloed filesystems to use as long term memory, scratchpads, or general purpose storage.\n\n## How It Works\n\n1. **API Server**: FastAPI backend that stores files in PostgreSQL\n2. **User Isolation**: Each user can only see/modify their own files (enforced by database)\n3. **Multiple Filesystems**: A user can have multiple filesystems and provide their agents with access to different, or the same filesystems.\n\n## [Beta] Quick Start\n\n### Creating an account on the Filesystem\n\n1. Navigate [here](https://auth.fs.langchain.com) and sign up for an account on the Filesystem. \n2. Create an API key and save it someplace secure!\n\n### Giving your agent access to the Filesystem\n\n1. Set your API key as an environment variable for your agent: `AGENT_FS_API_KEY=<api_key>`\n2. Specify the URL for the filesystem. If you're using our hosted solution, it is `AGENT_FS_URL=agent-file-system-production.up.railway.app`\n3. Instantiate the filesystem client, and give your agent access to the tools\n\n```python\nfrom ai_filesystem import FilesystemClient\n\nclient = FilesystemClient(\n filesystem=\"nicks-agent-filesystem\"\n)\nfilesystem_tools = client.create_tools() # list files, read file, create new file, and edit file\nagent.bind_tools(filesystem_tools)\n```\n\n3. In your agent's system prompt, make sure to specify how you want the agent to use the filesystem. Common use cases include as long-term memory, to store learnings and mistakes, or to save work products.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Virtual filesystem service for AI agents with LangChain integration",
"version": "0.1.3",
"project_urls": {
"Repository": "https://github.com/langchain-ai/agent-file-system"
},
"split_keywords": [
"langchain",
" ai",
" filesystem",
" agents",
" tools"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "bd46301ca6b80b9d75649327ab859e37be5ecd73b2a05b906b70099233a826cf",
"md5": "2cd4cd56df9ef3e16e944964754e68f2",
"sha256": "92801a133a4da11ef0d495d089fe947f2476b86ad2793dd788d5b8b1139486f8"
},
"downloads": -1,
"filename": "ai_filesystem-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2cd4cd56df9ef3e16e944964754e68f2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 7349,
"upload_time": "2025-08-01T01:21:07",
"upload_time_iso_8601": "2025-08-01T01:21:07.534938Z",
"url": "https://files.pythonhosted.org/packages/bd/46/301ca6b80b9d75649327ab859e37be5ecd73b2a05b906b70099233a826cf/ai_filesystem-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3e5be6724e897339f47f75f11c59d98c4ea7bd4eba3a89ff1494e96037e1cb7e",
"md5": "71a0fc3b7f4d7fd835408bcda56a280e",
"sha256": "11f04fbbe9d57f5ec65ca8427756450e91bc688f275e705377a6d2dcffe044bb"
},
"downloads": -1,
"filename": "ai_filesystem-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "71a0fc3b7f4d7fd835408bcda56a280e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 6504,
"upload_time": "2025-08-01T01:21:08",
"upload_time_iso_8601": "2025-08-01T01:21:08.455771Z",
"url": "https://files.pythonhosted.org/packages/3e/5b/e6724e897339f47f75f11c59d98c4ea7bd4eba3a89ff1494e96037e1cb7e/ai_filesystem-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-01 01:21:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "langchain-ai",
"github_project": "agent-file-system",
"github_not_found": true,
"lcname": "ai-filesystem"
}
