MarkdownMetadata

Struct MarkdownMetadata 

Source
pub struct MarkdownMetadata {
    pub title: Option<String>,
    pub description: Option<String>,
    pub version: Option<String>,
    pub author: Option<String>,
    pub tags: Vec<String>,
    pub resource_type: Option<String>,
    pub dependencies: Option<BTreeMap<String, Vec<DependencySpec>>>,
    pub extra: BTreeMap<String, Value>,
}
Expand description

Structured metadata extracted from Markdown frontmatter.

This struct represents all the metadata that can be parsed from YAML or TOML frontmatter in Markdown files. It follows a flexible schema that accommodates both standard AGPM fields and custom extensions.

§Standard Fields

The following fields have special meaning in AGPM:

  • title: Human-readable name for the resource
  • description: Brief explanation of what the resource does
  • version: Version identifier (semantic versioning recommended)
  • author: Creator or maintainer information
  • resource_type: Type classification (“agent” or “snippet”)
  • tags: Categorization labels for filtering and discovery
  • dependencies: Structured dependencies for transitive resolution

§Custom Fields

Additional fields are preserved in the extra map, allowing resource authors to include custom metadata without breaking compatibility.

§Serialization

The struct uses Serde for serialization with skip-if-empty optimizations to keep generated frontmatter clean. Empty collections and None values are omitted from the output.

§Example

let mut metadata = MarkdownMetadata::default();
metadata.title = Some("Python Linter".to_string());
metadata.version = Some("2.0.1".to_string());
metadata.tags = vec!["python".to_string(), "linting".to_string()];
// Dependencies can be set as a JSON value for the structured format
// This is typically parsed from frontmatter rather than set programmatically

// Custom fields via extra map
let mut extra = BTreeMap::new();
extra.insert("license".to_string(), "MIT".into());
extra.insert("min_python".to_string(), "3.8".into());
metadata.extra = extra;

Fields§

§title: Option<String>

Human-readable title of the resource.

This is displayed in listings and used for resource identification. If not provided, the title may be extracted from the first heading in the Markdown content.

§description: Option<String>

Brief description explaining what the resource does.

Used for documentation and resource discovery. If not provided, the description may be extracted from the first paragraph in the Markdown content.

§version: Option<String>

Version identifier for the resource.

Semantic versioning (e.g., “1.2.3”) is recommended for compatibility with dependency resolution, but any string format is accepted.

§author: Option<String>

Author or maintainer information.

Can be a name, organization, or contact information. Free-form text.

§tags: Vec<String>

Classification tags for categorization and filtering.

Tags help with resource discovery and organization. Common patterns:

  • Language-specific: “python”, “javascript”, “rust”
  • Functionality: “linting”, “testing”, “documentation”
  • Domain: “web-dev”, “data-science”, “devops”
§resource_type: Option<String>

Resource type classification.

Currently supported types:

  • “agent”: Interactive Claude Code agents
  • “snippet”: Code snippets and templates

This field uses rename = "type" to match the frontmatter format while avoiding Rust’s type keyword.

§dependencies: Option<BTreeMap<String, Vec<DependencySpec>>>

Dependencies for this resource.

This field uses the structured transitive dependency format where dependencies are organized by resource type (agents, snippets, etc.). Each resource type maps to a list of dependency specifications.

Example:

dependencies:
  agents:
    - path: agents/helper.md
      version: v1.0.0
  snippets:
    - path: snippets/utils.md
§extra: BTreeMap<String, Value>

Additional custom metadata fields.

Any frontmatter fields not recognized by the standard schema are preserved here. This allows resource authors to include custom metadata without breaking compatibility with AGPM.

Values are stored as serde_json::Value to handle mixed types (strings, numbers, arrays, objects). Uses BTreeMap for deterministic serialization order.

Implementations§

Source§

impl MarkdownMetadata

Source

pub fn get_agpm_metadata(&self) -> Option<AgpmMetadata>

Get AGPM-specific metadata from the extra fields.

Extracts the agpm section from the frontmatter if present, which may contain templating flags and nested dependencies.

Trait Implementations§

Source§

impl Clone for MarkdownMetadata

Source§

fn clone(&self) -> MarkdownMetadata

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for MarkdownMetadata

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for MarkdownMetadata

Source§

fn default() -> MarkdownMetadata

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for MarkdownMetadata

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for MarkdownMetadata

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,