Adapt
Adapt is a FastAPI server that turns files in a directory into APIs and UIs.
- Datasets (
.csv,.xlsx,.parquet) become CRUD endpoints and DataTables UIs - Markdown/HTML become browsable pages
- Media files become streaming endpoints and player/gallery UIs
- Python files can register custom routers
- Everything is searchable in one place via full-text
/search - Everything is reachable by agentic tools via an MCP server at
/mcp
Quick Start
pip install adapt-server
adapt addsuperuser --username admin /path/to/docroot
adapt serve /path/to/docroot
# Generate permissions for all discovered resources
adapt admin create-permissions /path/to/docroot __all__
# Everything below here can be done in the admin UI at
# http://localhost:8000/admin/ after logging in with the superuser account.
#
# Create a regular user
adapt admin create-user --username editor --password secret /path/to/docroot
# By default, the editor user has no permissions.
# See available groups (created by `adapt admin create-permissions`) and assign user to desired group
adapt admin list-groups /path/to/docroot
adapt admin add-to-group --username editor --group <group_name> /path/to/docroot
Useful URLs:
/landing page/admin/admin UI/api/<resource>resource API/ui/<resource>resource UI/schema/<resource>resource schema/searchfull-text search across every resource you can read/mcpMCP server for agentic tools (see MCP Interface below)
What Adapt Generates
From files in your docroot, Adapt auto-discovers resources and mounts routes with extensionless URLs where possible.
Example:
data/
employees.csv
sales.xlsx
video.mp4
readme.md
stats.py
Rough output:
/api/employees,/ui/employees,/schema/employees/api/sales/<sheet>,/ui/sales/<sheet>/media/video.mp4,/ui/video.mp4,/ui/media/readme/api/stats/*
Current Security Posture
This reflects the current implementation in the codebase.
In Place
- Authentication: session cookies and API keys (
X-API-Key) - Authorization: RBAC (users, groups, permissions), plus superuser bypass
- Password security: PBKDF2 hashing with per-user salts
- Session security: expiration enforcement, sliding renewal, cleanup task
- CSRF protection: enforced for cookie-authenticated unsafe methods (
POST/PUT/PATCH/DELETE), including mixed session + API-key requests - Redirect hardening: login
nextpaths are validated as local relative paths - Response hardening: CSP,
X-Frame-Options,X-Content-Type-Options,Referrer-Policy,Permissions-Policy, HSTS (when TLS is enabled) - Host header hardening: Trusted Host middleware
- Data integrity: lock-based, atomic writes for mutable dataset plugins
- Auditability: admin/audit logging for security-relevant actions
- Sensitive response cleanup: admin user APIs no longer expose
password_hash
Important Deployment Notes
- Use TLS in non-local environments (
--tls-cert+--tls-key) so secure cookies and HSTS protections are effective. - API-key-only clients are exempt from CSRF checks by design; cookie-auth browser flows require CSRF tokens.
Core Features
- Adaptive discovery and route generation
- Dataset CRUD with schema exposure
- Caching with invalidation on mutations
- Built-in admin UI for users/groups/permissions/locks/cache/api keys/audit logs
- Plugin architecture with companion overrides in
.adapt/ - Permission-filtered full-text search across every resource type
- MCP server for agentic tool access, mounted alongside the REST API
Full-Text Search
GET /search?q=<query> searches datasets, Markdown, HTML, and media metadata
in one ranked list, filtered to what the caller may read — a query term that
matches a resource you can't see never shows up, and never leaks via the
result count either.
curl -H "X-API-Key: <key>" "http://localhost:8000/search?q=parental+leave"
The index refreshes incrementally on startup (search_on_startup, default
true) and can be rebuilt on demand with adapt reindex <root>. See the
API Reference for query
parameters and result shape.
MCP Interface
Adapt mounts a Model Context Protocol
server at /mcp, on the same host/port as everything else, exposing five
tools that wrap the same permission checks and plugin methods as the REST
API — list_resources, get_schema, read_resource, write_resource, and
search. There's no separate process, no separate API surface, and no
extra permission model to maintain.
Minimal walkthrough — create an account for the agent, grant it read access, mint an API key, and connect a client:
adapt addsuperuser /path/to/docroot --username admin
adapt serve /path/to/docroot &
adapt admin create-permissions /path/to/docroot __all__
adapt admin create-user /path/to/docroot --username agent --password <strong-password>
adapt admin add-to-group /path/to/docroot --username agent --group <resource>_readonly
Log in as agent and self-issue an API key from /profile (any
authenticated user can create their own key — no superuser needed), then
point a client at /mcp with that key:
# Claude Code CLI
claude mcp add --transport http adapt http://localhost:8000/mcp \
--header "X-API-Key: <key>"
// Generic MCP client config (Claude Desktop and similar)
{
"mcpServers": {
"adapt": {
"url": "http://localhost:8000/mcp",
"headers": { "X-API-Key": "<key>" }
}
}
}
MCP requires an API key on every call — there's no session-cookie or
anonymous path, since MCP has no concept of a browser session. Set
mcp_enabled: false in .adapt/conf.json (or ADAPT_MCP_ENABLED=false) to
remove /mcp entirely. Full walkthrough, troubleshooting, and the tool
reference table: docs/manual/mcp_guide.md.
For dataset reads, sort is the column name and order must be asc or
desc.
Dataset Mutation Envelope
For dataset endpoints, write operations use this payload structure:
{
"action": "create|update|delete",
"data": []
}
Use object data for update/delete as needed (for example, with _row_id).
CLI (Common Commands)
adapt serve <root> [--host ... --port ... --tls-cert ... --tls-key ... --reload --readonly --debug]
adapt check <root>
adapt addsuperuser <root> --username <name>
adapt list-endpoints <root>
adapt reindex <root> [--force]
adapt admin list-resources <root>
adapt admin create-permissions <root> __all__
Documentation
Detailed docs live under docs/manual/.
- Manual index: docs/manual/index.md
- Security: docs/manual/security.md
- Quick start: docs/manual/quick_start.md
- Configuration: docs/manual/configuration.md
- API reference: docs/manual/api_reference.md
- MCP guide: docs/manual/mcp_guide.md
- Plugin development: docs/manual/plugin_development.md
License
MIT. See LICENSE.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file adapt_server-0.2.5.tar.gz.
File metadata
- Download URL: adapt_server-0.2.5.tar.gz
- Upload date:
- Size: 122.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a9d624d19227dab7ee7c4ed541420470bbe7f9f30baec07a3309bd869a606acd
|
|
| MD5 |
deb6888d5b2c7d4cf5ba7b6b6f0043b6
|
|
| BLAKE2b-256 |
58223dd88879265fbea0117df37ba0be68d3a4c5f39fd29b6451a714af944909
|
Provenance
The following attestation bundles were made for adapt_server-0.2.5.tar.gz:
Publisher:
publish-pypi.yml on McIndi/adapt
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
adapt_server-0.2.5.tar.gz -
Subject digest:
a9d624d19227dab7ee7c4ed541420470bbe7f9f30baec07a3309bd869a606acd - Sigstore transparency entry: 2260579098
- Sigstore integration time:
-
Permalink:
McIndi/adapt@e3252351ed790c1fe64b1ebf860a892d18dd7930 -
Branch / Tag:
refs/tags/v0.2.5 - Owner: https://github.com/McIndi
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@e3252351ed790c1fe64b1ebf860a892d18dd7930 -
Trigger Event:
release
-
Statement type:
File details
Details for the file adapt_server-0.2.5-py3-none-any.whl.
File metadata
- Download URL: adapt_server-0.2.5-py3-none-any.whl
- Upload date:
- Size: 121.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f71911d881198c7d9f71b15ae45002e55de2ffb9cce98c771b8951fdec383ccc
|
|
| MD5 |
c9fe16874169463b0d779f116905859c
|
|
| BLAKE2b-256 |
6ab0d36cc1193907b29e98da05b6951e1ef493dd25a2f298a0634acf9e84dad1
|
Provenance
The following attestation bundles were made for adapt_server-0.2.5-py3-none-any.whl:
Publisher:
publish-pypi.yml on McIndi/adapt
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
adapt_server-0.2.5-py3-none-any.whl -
Subject digest:
f71911d881198c7d9f71b15ae45002e55de2ffb9cce98c771b8951fdec383ccc - Sigstore transparency entry: 2260579173
- Sigstore integration time:
-
Permalink:
McIndi/adapt@e3252351ed790c1fe64b1ebf860a892d18dd7930 -
Branch / Tag:
refs/tags/v0.2.5 - Owner: https://github.com/McIndi
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@e3252351ed790c1fe64b1ebf860a892d18dd7930 -
Trigger Event:
release
-
Statement type: