SUMD - Structured Unified Markdown Descriptor for AI-aware project documentation
Project description
SUMD
SUMD is a semantic project descriptor format in Markdown that defines intent, structure, execution entry points, and mental model of a system for both humans and LLMs.
What is SUMD?
SUMD (Structured Unified Markdown Descriptor) is a lightweight structured markdown format for AI-aware project descriptions. It serves as a single source of truth for project documentation, optimized for both human readability and LLM context injection.
Purpose
- Project descriptor: Defines API, CLI, workflows, endpoints, and system architecture
- AI-optimized: Structured for LLM consumption and automation tools
- Lightweight manifest: Bridges the gap between README, spec, and configuration files
- Context injection: Provides structured context for AI agents and tools
Use Cases
- Project documentation and specification
- Input for LLM context injection
- CI/CD workflow descriptions
- API and CLI mapping
- Structural project manifest
License
Licensed under Apache-2.0.
Release history Release notifications | RSS feed
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 sumd-0.1.5.tar.gz.
File metadata
- Download URL: sumd-0.1.5.tar.gz
- Upload date:
- Size: 10.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5df82213d1966f1d7da492b1b08ec65905890a10cf6444325d2337647c849849
|
|
| MD5 |
314c61e063860c2e7a09d381d11c4aaf
|
|
| BLAKE2b-256 |
e49db0f09ed8e9a7d83080ae608cb61df26c0e4a312f8bfe05154c83e9a9b3b6
|
File details
Details for the file sumd-0.1.5-py3-none-any.whl.
File metadata
- Download URL: sumd-0.1.5-py3-none-any.whl
- Upload date:
- Size: 9.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c4ce3d487709cf6345161f2b41f8ba4a8ead29fd0af878aee03abcb673abcd3a
|
|
| MD5 |
5f52256bdb652471f70e7ad6f39073e4
|
|
| BLAKE2b-256 |
db3fbebd461259ff7c44cbca1b8f1ae31510d7fe24fd13c248001e8f707d2e3c
|
