Skip to main content

OAuthConfig

Struct OAuthConfig 

Source
pub struct OAuthConfig {
    pub issuer: Option<String>,
    pub mcp_server_url: Option<String>,
    pub client_id: Option<String>,
    pub client_name: Option<String>,
    pub dcr_enabled: bool,
    pub scopes: Vec<String>,
    pub cache_file: Option<PathBuf>,
    pub redirect_port: u16,
}
Expand description

OAuth configuration for CLI authentication flows.

§Migration note (pmcp 2.5.0)

client_id changed from String to Option<String> to support RFC 7591 Dynamic Client Registration. Existing callers that passed a pre-registered id must now wrap it in Some(...):

// Before (pmcp < 2.5.0):
OAuthConfig { client_id: "my-client".to_string(), /* ... */ }
// After (pmcp 2.5.0+):
OAuthConfig {
    client_id: Some("my-client".to_string()),
    client_name: None,
    dcr_enabled: false,
    /* ... */
}

Fields§

§issuer: Option<String>

OAuth issuer URL (e.g., https://auth.example.com). If None, will auto-discover from MCP server URL.

§mcp_server_url: Option<String>

MCP server URL for auto-discovery (required if issuer is None).

§client_id: Option<String>

OAuth client ID. When None and dcr_enabled is true and the discovery metadata advertises a registration_endpoint, the SDK auto-performs RFC 7591 Dynamic Client Registration to obtain one.

§client_name: Option<String>

Client name advertised to the authorization server during DCR (RFC 7591 §2). Only consulted when DCR fires. Falls back to the literal "pmcp-sdk" if None at DCR time.

§dcr_enabled: bool

Enable RFC 7591 Dynamic Client Registration when client_id is None and the server advertises a registration_endpoint. Defaults to true via Default::default(); set to false to opt out and require an explicit client_id.

§scopes: Vec<String>

OAuth scopes to request.

§cache_file: Option<PathBuf>

Cache file path for storing tokens.

§redirect_port: u16

Redirect port for localhost callback (default: 8080).

Trait Implementations§

Source§

impl Clone for OAuthConfig

Source§

fn clone(&self) -> OAuthConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OAuthConfig

Source§

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

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

impl Default for OAuthConfig

Source§

fn default() -> OAuthConfig

Returns the “default value” for a type. 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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> 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<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