Neon
Postgres, on a serverless platform designed to help you build reliable and scalable applications faster
VIEWS
1346
USERS
143
CATEGORY
Developer Tools & DevOps
VERSION
Install MCP Server
Paste and run this command in your terminal to set up Cursor with MCP
After running the command, restart Cursor to start using the MCP Server.
Available Tools
Access Project Details By Id
Retrieves detailed information about a specific project within the neon b2b saas integration platform. this endpoint is used to fetch comprehensive data about a project, including its configuration, associated workflows, and current status. it's particularly useful when you need to review or analyze the settings and progress of an integration project. the endpoint should be used when detailed project information is required, such as during troubleshooting, reporting, or when preparing to make updates to a project. it does not modify any project data and is safe for frequent calls. however, it may not provide real-time updates for ongoing integration processes; for that, a separate status or logs endpoint might be more appropriate.
Add New Jwks To Project Endpoint
Adds a new json web key set (jwks) to a specific endpoint of a project in the neon b2b saas integration platform. this endpoint is crucial for setting up secure authentication and authorization mechanisms, allowing seamless integration with various identity providers. use this when configuring a new authentication source or updating existing jwks information for your project. the endpoint supports multiple authentication providers and allows for branch-specific configurations and role mappings. note that a maximum of 10 role names can be associated with each jwks.
Add Project Email Permission
Adds permissions for a specified email address to a particular project within the neon b2b saas integration platform. this endpoint is used to grant access or specific rights to users for a given project, enabling collaboration and controlled resource sharing. it should be called when you need to add a new user to a project or modify existing user permissions. the endpoint associates the provided email with the specified project, likely setting up default or predefined permission levels. note that this endpoint only adds permissions and does not provide information about existing permissions or remove them.
Add Role To Branch
Creates a new role within a specific branch of a project in the neon b2b saas integration platform. this endpoint allows for fine-grained access control by enabling the creation of custom roles at the branch level. it should be used when setting up or modifying the permission structure for a particular branch within a project. the created role can later be assigned to users, granting them specific permissions within the branch context. note that this endpoint only creates the role; additional steps may be required to assign permissions to the role or associate it with users.
Create Api Key For Organization
Creates a new api key for the specified organization, with optional project-specific access limitations. this endpoint is used to generate and manage api keys, which are essential for authenticating and authorizing access to neon's b2b saas integration platform. the created api key can be used to interact with various services and endpoints within the organization's scope. if a project id is provided, the api key's access will be restricted to that specific project, enabling fine-grained access control. this is particularly useful in multi-project environments where different teams or integrations require isolated access. the endpoint requires a key name to be specified, allowing for easy identification and management of multiple api keys within the organization. it's important to note that the actual api key value will be returned in the response, and should be securely stored as it cannot be retrieved later.
Create Branch Database
Creates a new database within a specified project and branch in the neon platform. this endpoint allows users to set up a new database with a custom name and assign an owner role, facilitating the organization and management of databases within the neon ecosystem. it should be used when initializing a new database for a specific project or when branching requires a separate database instance. the endpoint is particularly useful for developers and database administrators who need to quickly set up new databases as part of their workflow or application deployment process. note that this operation only creates the database; additional steps may be required to configure specific schemas, tables, or access permissions within the newly created database.
Create Compute Endpoint
Creates a new compute endpoint for a specified branch within a neon project. this endpoint allows for detailed configuration of database resources, including read/write capabilities, regional placement, autoscaling limits, and connection pooling settings. it's primarily used when setting up new database instances or modifying existing database configurations to meet specific performance, scaling, or operational requirements. the endpoint provides fine-grained control over compute resources, enabling optimized database operations for various use cases from development to production environments.
Create New Api Key
Creates a new api key for accessing the neon b2b saas integration platform. this endpoint should be used when setting up new integrations, creating separate keys for different environments (e.g., production, testing), or rotating existing keys for security purposes. the created api key will be used for authenticating and authorizing requests to other neon api endpoints. note that this endpoint only creates the key; it does not manage permissions or access levels, which must be configured separately. after creation, ensure the key is securely stored, as it may not be retrievable in plain text again.
Create New Project Branch
Creates a new branch in a neon project with optional compute endpoints. this endpoint allows you to specify the parent branch, branch name, and various configuration options for both the branch and its compute endpoints. it can be used to create development environments, test new features, or set up isolated database instances. the endpoint supports advanced features like autoscaling, custom provisioners, and suspend timeout configuration for optimizing resource usage and performance.
Create Project With Quota And Settings
Creates a new neon project with specified configuration settings. this endpoint allows you to set up a customized postgresql environment with various options for resource management, networking, and performance optimization. it's ideal for initializing a new database project with tailored settings for quota management, ip access control, autoscaling, and more. use this when you need to establish a new neon project with specific requirements or when you want to take advantage of neon's advanced features like logical replication or custom maintenance windows. note that some settings, once configured, may not be easily changed later, so careful consideration of your project needs is recommended before creation.
Create Vpc Endpoint Label
Updates the label of a specific vpc endpoint within a project in the neon b2b saas integration platform. this endpoint allows users to modify the identifier of an existing vpc endpoint, enhancing organization and management of network resources. it should be used when there's a need to rename or re-categorize a vpc endpoint for better clarity or changed purposes. the operation is idempotent, meaning repeated calls with the same label will not create additional changes. note that this endpoint only updates the label and does not modify any other properties or configurations of the vpc endpoint.
Create Vpc Endpoint With Label
Updates the label of a specific vpc endpoint within an organization's virtual private cloud (vpc) in a particular aws region. this endpoint allows you to change the descriptive name or identifier associated with a vpc endpoint, which can be useful for better organization and management of your vpc resources. the new label helps in identifying and categorizing the vpc endpoint within your infrastructure. this endpoint should be used when you need to modify the existing label of a vpc endpoint, perhaps due to changes in its purpose or to align with updated naming conventions in your organization. it's important to note that this operation only updates the label and does not affect the functionality or configuration of the vpc endpoint itself.
Delete Api Key By Id
Deletes a specific api key from the neon platform. this endpoint should be used when you need to revoke access for a particular api key, such as when an employee leaves the organization or when you suspect the key has been compromised. the operation is irreversible, so use it with caution. once deleted, any applications or services using this api key will lose access to neon's api. this endpoint helps maintain the security of your neon account by allowing you to manage and control api key access effectively.
Delete Database From Branch
Deletes a specific database from a designated branch within a project in the neon platform. this endpoint should be used when you need to permanently remove a database and all its associated data from a particular branch of a project. it's crucial to use this endpoint with caution as the deletion operation is irreversible. this tool is particularly useful for cleaning up unnecessary databases, managing storage, or removing test databases that are no longer needed. however, it should not be used for temporary data management; instead, consider using database suspension or archiving features if available. note that this operation only affects the specified branch and does not impact the database in other branches or the main project.
Delete Organization Api Key
Deletes a specific api key associated with an organization in the neon platform. this endpoint is used to revoke access for a particular api key, enhancing security by removing unused or compromised keys. it should be used when an api key is no longer needed, when rotating keys for security purposes, or when an api key may have been exposed. once deleted, the api key cannot be recovered, and any systems using this key will lose access to the neon api. ensure you have a backup or replacement key in place before deletion to avoid service interruptions.
Delete Organization Member
Removes a specific member from an organization within the neon b2b saas integration platform. this endpoint should be used when an organization administrator needs to revoke a user's membership, such as when an employee leaves the company or their role changes. the operation is permanent and will immediately remove the member's access to the organization's resources within neon. it's important to note that this action cannot be undone through the api, and re-adding a removed member would require a new invitation process. use this endpoint with caution, as it directly affects user access and organization structure.
Delete Project Branch By Id
Deletes a specific branch within a project in the neon b2b saas integration platform. this endpoint permanently removes the specified branch and all associated data from the project. it should be used when a branch is no longer needed, such as after merging changes or abandoning a development path. caution should be exercised when using this endpoint, as the deletion is irreversible. it's important to ensure that any valuable data or configurations in the branch have been backed up or merged before deletion. this operation cannot be undone, so double-checking the project id and branch id before execution is crucial to avoid accidental deletions.
Delete Project Branch Role
Deletes a specific role from a branch within a project in the neon b2b saas integration platform. this endpoint is used to remove access permissions associated with a particular role in a specific project branch. it's particularly useful when restructuring access control or removing obsolete roles from a project's branch. the operation is permanent and cannot be undone, so it should be used with caution. this endpoint does not return any data upon successful deletion, typically responding with a 204 no content status.
Delete Project By Id
Deletes a specific project from the neon b2b saas integration platform. this endpoint permanently removes all data, configurations, and resources associated with the specified project. it should be used with caution, as the deletion process is irreversible. this operation is typically performed when a project is no longer needed or to clean up unused resources. the endpoint requires the project's unique identifier and likely needs proper authentication to ensure only authorized users can delete projects. after successful deletion, the project and its data will no longer be accessible through any other api endpoints.
Delete Project Endpoint
Deletes a specific endpoint within a neon project. this operation permanently removes the endpoint and all associated resources, such as configurations and access points. use this endpoint when you need to decommission or clean up unused endpoints in your project. it's important to note that this action is irreversible, so ensure you have backed up any necessary data or configurations before proceeding. this endpoint should be used with caution, as it will immediately terminate access to the specified endpoint and may impact any systems or applications relying on it.
20 actions available