Server definition
- Hash
- sha256:c868645b4784fcce8beec7591394abfe2b72fdc78f8b8019ad5b183a43089652
- What it is
- What a remote MCP server returned when asked what it offers: 35 tools
The blob, as servednamed by its sha256
{
"instructions": "First helps couples make a prenuptial agreement and related agreements. These tools read the customer's own First account. They save the answers of the quiz modules, the assets and the family members of the customer, and the steps of alignment. Before a tool gives account data, the customer has not signed in to First, and only ask_clara works. Then answer a question with ask_clara. Clara knows First and prenups in general, but not the account of the customer. With the first answer, show the customer the notice of the answer, with the links terms_url and privacy_url. Call get_started only when the customer wants to start or continue a prenup or another First agreement. Tell the customer that the app then asks them to sign in, make an account, and accept the consent page. After a tool gives account data, leave out the thread_id of ask_clara to start a new thread. Then, at the first message or at a message that is only a greeting, call get_started, greet the customer by first name, and do not say the stage value to the customer. When the message of the customer is only a greeting, offer the choices of get_started one time in the conversation and wait for the answer, or give the next step when there are no choices. When the message is not only a greeting, answer it, and give the next step when the customer asks what to do. When the customer has no agreement, get_started gives the products to start. If the customer only wants answers, use ask_clara, and do not offer the products or the setup again unless the customer asks. Call update_profile to save the customer's legal name. Call get_my_details for the customer's own email, phone, partner, and purchases. To change the email, call request_email_change. The customer approves the change from the current email. When get_started gives welcome, do the welcome steps in the chat, and get an explicit yes to each statement before you call finish_welcome_steps. Call ask_clara for questions about how First works and prenups in general. Call read_document for the customer's documents. With Lawyer Review, the lawyer stage stays in the First app: the lawyer, the lawyer's comments, the lawyer documents, and the agreement text after the lawyer review starts. For these, give the customer the app link. Call read_agreement for what the customer's agreement says. Call describe_asset_form or describe_family_form before you add or change an asset or a family member. The list and describe tools give the module_state. Read it before you collect values or delete. When it is closed, give the customer next_step_url and do not call a write tool. When it is edit_restarts_alignment, tell the customer that the change restarts the alignment of the couple and can email the partner, and get a yes. Send the module_state that you read for that module as expected_module_state in each asset or family write, also when it is open. When a write refuses because the state changed, tell the customer the new state and ask again. After an asset, family, or allocation write, tell the customer that the alignment restarted when alignment_restarted is true. Tell the customer that the partner got an email when partner_emailed is true. When a value is false, say nothing about it. When the customer asks about these values, answer from the results of all the writes in this conversation. For a bank account, a credit card, an investment, or a debt, when describe_asset_form gives plaid_connection_url, the customer connects the account through Plaid in the app with it, or gives the account here for add_asset. Never ask for the sign-in details of an account. When a result or a refusal says that a module waits for the partner, do not offer that module. Tell the customer where the partner is, as the text says, and offer what the customer can do now, such as ask_clara. When the customer says that the assets or the family members are complete, call complete_my_assets or complete_my_family after an explicit yes to the statement of the tool. Do alignment with get_alignment. The steps go in this order: financial-views, partners-premarital-property, partners-postmarital-property, postmarital-property. Show the data of a step before each write of the step. Show each premarital asset of the partner before you complete partners-premarital-property. Before set_allocation, read module_state as for an asset write. When ready_to_complete is true, call complete_alignment after an explicit yes. When get_alignment gives complete_statement, show it first. Call invite_partner to invite the customer's partner. Except for the statements of the welcome steps, of the complete tools, and of alignment, the customer signs, pays, selects a lawyer, gives consent, and edits the agreement text only in the First app: for these steps, give the customer the app link. First is not a law firm, and these tools do not give legal advice.",
"tools": [
{
"description": "Adds an asset or a debt to the customer's My Assets page. Call describe_asset_form for the fields and the module_state first. Confirm the values with the customer before you call this tool. When module_state is edit_restarts_alignment, also tell the customer that the change restarts the alignment of the couple and can email the partner, and get a yes. After an asset, family, or allocation write, tell the customer that the alignment restarted when alignment_restarted is true. Tell the customer that the partner got an email when partner_emailed is true. When a value is false, say nothing about it. When the customer asks about these values, answer from the results of all the writes in this conversation. For a bank account, a credit card, an investment, or a debt, when describe_asset_form gives plaid_connection_url (for example /prenup/my-assets/bank), offer two choices: the customer connects the account through Plaid in the app, or gives the account here for this tool. A Plaid connection in the app also restarts the alignment when module_state is edit_restarts_alignment, so get the same yes first. Never ask for the sign-in details of an account. Send the module_state that you read as expected_module_state, also when it is open.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"expected_module_state": {
"description": "The module_state that you read from the list or describe tool of this module, also when it is open. When the state is now different, the tool saves nothing and gives the new state.",
"enum": [
"open",
"edit_restarts_alignment",
"closed"
],
"type": "string"
},
"fields": {
"additionalProperties": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"description": "The values of the form, by the field keys of the describe tool. Give each currency amount in US dollars, with up to 2 decimals. The amount of a debt is positive.",
"minProperties": 1,
"type": "object"
},
"kind": {
"description": "The kind of asset or debt.",
"enum": [
"bank",
"creditCard",
"investment",
"loan",
"retirement",
"vehicle",
"realEstate",
"business",
"other",
"intangible",
"trust",
"jewelry",
"collectible",
"crypto",
"cash",
"socialMediaAccount",
"militaryBenefits",
"inheritanceReceived"
],
"type": "string"
}
},
"required": [
"kind",
"fields"
],
"type": "object"
},
"name": "add_asset",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"alignment_restarted": {
"description": "True when the write restarted the alignment of the couple.",
"type": "boolean"
},
"app_url": {
"type": "string"
},
"asset": {
"properties": {
"currency": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"enum": [
"customer",
"partner"
],
"type": "string"
},
"separate_property": {
"type": "boolean"
},
"shared": {
"type": "boolean"
},
"subkind": {
"type": "string"
},
"value": {
"description": "In the currency. A debt has a negative value. An intellectual property or social media asset has no value, as in the agreement.",
"type": "number"
}
},
"required": [
"id",
"kind",
"subkind",
"name",
"currency",
"owner",
"shared",
"separate_property"
],
"type": "object"
},
"partner_emailed": {
"description": "True when the partner got an email that the alignment restarted.",
"type": "boolean"
},
"status": {
"enum": [
"saved"
],
"type": "string"
}
},
"required": [
"status",
"asset",
"app_url",
"alignment_restarted",
"partner_emailed"
],
"type": "object"
}
},
{
"description": "Adds a dependent or a pet to the customer's My Family page. Call describe_family_form for the fields and the module_state first. Confirm the values with the customer before you call this tool. When module_state is edit_restarts_alignment, also tell the customer that the change restarts the alignment of the couple and can email the partner, and get a yes. After an asset, family, or allocation write, tell the customer that the alignment restarted when alignment_restarted is true. Tell the customer that the partner got an email when partner_emailed is true. When a value is false, say nothing about it. When the customer asks about these values, answer from the results of all the writes in this conversation. Send the module_state that you read as expected_module_state, also when it is open.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"expected_module_state": {
"description": "The module_state that you read from the list or describe tool of this module, also when it is open. When the state is now different, the tool saves nothing and gives the new state.",
"enum": [
"open",
"edit_restarts_alignment",
"closed"
],
"type": "string"
},
"fields": {
"additionalProperties": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"description": "The values of the form, by the field keys of the describe tool. Give each currency amount in US dollars, with up to 2 decimals. The amount of a debt is positive.",
"minProperties": 1,
"type": "object"
},
"kind": {
"description": "dependent or pet.",
"enum": [
"dependent",
"pet"
],
"type": "string"
}
},
"required": [
"kind",
"fields"
],
"type": "object"
},
"name": "add_family_member",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"alignment_restarted": {
"description": "True when the write restarted the alignment of the couple.",
"type": "boolean"
},
"app_url": {
"type": "string"
},
"family_member": {
"properties": {
"id": {
"type": "string"
},
"kind": {
"enum": [
"dependent",
"pet"
],
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"enum": [
"customer",
"partner"
],
"type": "string"
},
"shared": {
"type": "boolean"
},
"subkind": {
"type": "string"
}
},
"required": [
"id",
"kind",
"subkind",
"name",
"owner",
"shared"
],
"type": "object"
},
"partner_emailed": {
"description": "True when the partner got an email that the alignment restarted.",
"type": "boolean"
},
"status": {
"enum": [
"saved"
],
"type": "string"
}
},
"required": [
"status",
"family_member",
"app_url",
"alignment_restarted",
"partner_emailed"
],
"type": "object"
}
},
{
"description": "Saves the answer of the customer to the current question of a quiz module, and returns the next question. Confirm the answer with the customer before you call this tool. Give the answer in the format that answer_format of the question names. A changed answer can remove the answers of questions that it hides, and it can restart the alignment of the couple. For the last screen of the quiz, give only the question_id: this finishes the module. The eligibility quiz finishes after its last question, and the result gives the next step and app_url. A result with status ineligible gives the reason and app_url: give both to the customer.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"address": {
"additionalProperties": false,
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"state": {
"type": "string"
},
"zipcode": {
"type": "string"
}
},
"type": "object"
},
"module_slug": {
"description": "The slug of the quiz module, for example basic-information or financial-philosophy. Use eligibility, with product, for the eligibility questions before payment.",
"type": "string"
},
"option_ids": {
"description": "The selected option ids.",
"items": {
"type": "string"
},
"type": "array"
},
"other_text": {
"description": "The text of the customer for the option Other.",
"type": "string"
},
"pets": {
"items": {
"additionalProperties": false,
"properties": {
"option_id": {
"type": "string"
},
"pet_id": {
"type": "string"
}
},
"required": [
"pet_id",
"option_id"
],
"type": "object"
},
"type": "array"
},
"product": {
"description": "The product line. Send it for the eligibility questions, and when the customer has more than one paid agreement.",
"enum": [
"prenup",
"babynup"
],
"type": "string"
},
"question_id": {
"description": "The question_id of the current question.",
"type": "string"
},
"value": {
"description": "The value of an input question.",
"type": [
"string",
"number"
]
}
},
"required": [
"module_slug",
"question_id"
],
"type": "object"
},
"name": "answer_quiz_question",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"allocation_kind": {
"enum": [
"asset",
"marital_property"
],
"type": "string"
},
"answer_format": {
"type": "string"
},
"app_url": {
"type": "string"
},
"body": {
"type": "string"
},
"educational_copy": {
"type": "object"
},
"field_label": {
"type": "string"
},
"items": {
"description": "The items of an allocation question. picked is false until the customer picks.",
"items": {
"type": "object"
},
"type": "array"
},
"kind": {
"type": "string"
},
"module_slug": {
"type": "string"
},
"module_state": {
"description": "The state of the module for a write of the customer. open: a write saves. edit_restarts_alignment: a write saves, restarts the alignment of the couple, and can email the partner. Tell the customer this and get a yes before the write. closed: the tools refuse a write. Do not collect values. Give the customer next_step_url.",
"enum": [
"open",
"edit_restarts_alignment",
"closed"
],
"type": "string"
},
"next_step": {
"type": "string"
},
"next_step_url": {
"description": "Only for a closed module: the app page that shows the next step.",
"type": "string"
},
"notes": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"pets": {
"items": {
"type": "object"
},
"type": "array"
},
"progress": {
"type": "integer"
},
"question_id": {
"type": "string"
},
"saved_answer": {
"type": "object"
},
"status": {
"enum": [
"question",
"allocation",
"in_app",
"complete",
"ineligible"
],
"type": "string"
},
"subtitle": {
"type": "string"
},
"title": {
"type": "string"
},
"waiting_for_partner": {
"type": "string"
}
},
"required": [
"status",
"module_slug",
"app_url"
],
"type": "object"
}
},
{
"description": "Asks Clara, the First assistant, a question for the customer. Use it for a general question about prenups (prenuptial agreements), for example \"Do I need a prenup?\" or \"What can a prenup cover?\", and for a question about First. Clara knows the First app and the general legal points of a prenup. When the customer is signed in, Clara also knows the customer's account. Send only the customer's question. Send the thread_id of an earlier answer to continue that conversation. Before sign-in, the result has notice, terms_url, and privacy_url: show the notice to the customer with the first answer, with both links.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"product": {
"description": "The product line that the question is about. Leave it out for a general question.",
"enum": [
"prenup",
"babynup"
],
"type": "string"
},
"question": {
"description": "The customer's question.",
"pattern": "\\S",
"type": "string"
},
"thread_id": {
"description": "The thread_id of an earlier ask_clara answer.",
"type": "string"
}
},
"required": [
"question"
],
"type": "object"
},
"name": "ask_clara",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"answer": {
"type": "string"
},
"notice": {
"type": "string"
},
"privacy_url": {
"type": "string"
},
"terms_url": {
"type": "string"
},
"thread_id": {
"type": "string"
}
},
"required": [
"answer",
"thread_id"
],
"type": "object"
}
},
{
"description": "Completes alignment, as the Complete Alignment button of the app does. Call it only when get_alignment gives ready_to_complete true, and the customer says to complete alignment. When get_alignment gives complete_statement, show this exact statement first, and get an explicit yes: \"Once you complete alignment, any further changes to your prenup will need to be done by a lawyer. Are you sure you want to continue?\" Then call with confirm true. When both partners completed alignment, the app makes the draft prenup. The completion emails the customer and the partner. Give the customer next_step or waiting_for_partner. When the result gives upgrade, offer the upgrade to Lawyer Review with its text and url.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirm": {
"description": "True only after the customer said yes to complete alignment, and to complete_statement when get_alignment gives it.",
"enum": [
true
],
"type": "boolean"
}
},
"required": [
"confirm"
],
"type": "object"
},
"name": "complete_alignment",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"app_url": {
"description": "The dashboard of the app.",
"type": "string"
},
"completed_now": {
"description": "False when alignment was already complete. The tool then changed nothing.",
"type": "boolean"
},
"next_step": {
"description": "The current module of the customer.",
"type": "string"
},
"status": {
"enum": [
"completed"
],
"type": "string"
},
"upgrade": {
"description": "Only for a prenup that can upgrade to Lawyer Review: the offer of the app.",
"properties": {
"text": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"waiting_for_partner": {
"description": "Why the next module waits for the partner.",
"type": "string"
}
},
"required": [
"status",
"completed_now",
"app_url"
],
"type": "object"
}
},
{
"description": "Completes one step of alignment, as the Complete Review button of its page does. Each step has the condition of its page: financial-views needs each question aligned. For partners-premarital-property, first show the customer each premarital asset of the partner (get_alignment with this step), and get a yes that the customer reviewed them. partners-postmarital-property needs a review of each item of the partner. postmarital-property needs no disagreement of the partner: the customer picks such an item again with set_allocation, and the partner reviews it again. The completion can open the next step and email the customer and the partner. Give the customer next_step, or waiting_for_partner.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirm": {
"description": "True only after the customer said to complete the step.",
"enum": [
true
],
"type": "boolean"
},
"step": {
"enum": [
"financial-views",
"partners-premarital-property",
"partners-postmarital-property",
"postmarital-property"
],
"type": "string"
}
},
"required": [
"step",
"confirm"
],
"type": "object"
},
"name": "complete_alignment_step",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"app_url": {
"type": "string"
},
"completed_now": {
"description": "False when the step was already complete. The tool then changed nothing.",
"type": "boolean"
},
"next_step": {
"description": "The current module of the customer.",
"type": "string"
},
"ready_to_complete": {
"description": "Each step is complete for both partners: call complete_alignment.",
"type": "boolean"
},
"status": {
"enum": [
"completed"
],
"type": "string"
},
"waiting_for_partner": {
"description": "Why the next step waits for the partner.",
"type": "string"
}
},
"required": [
"status",
"completed_now",
"ready_to_complete",
"app_url"
],
"type": "object"
}
},
{
"description": "Completes the My Assets module, as the Complete button of the app does. Call it only when the customer says that the assets and the debts are complete. First call list_assets, and show the customer the full list of assets and debts. Then show this exact statement, and get an explicit yes: \"I understand that full financial disclosure is key to the enforceability of my prenup and that it is my responsibility to share a complete version of my assets and liabilities.\" Then call with confirm true. The completion can open the next module and email the customer and the partner. Give the customer next_step.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirm": {
"description": "True only after the customer said yes to the statement of the description.",
"enum": [
true
],
"type": "boolean"
},
"expected_module_state": {
"description": "The module_state that you read from the list or describe tool of this module, also when it is open. When the state is now different, the tool saves nothing and gives the new state.",
"enum": [
"open",
"edit_restarts_alignment",
"closed"
],
"type": "string"
}
},
"required": [
"confirm"
],
"type": "object"
},
"name": "complete_my_assets",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"app_url": {
"description": "The dashboard of the app.",
"type": "string"
},
"completed_now": {
"description": "False when the module was already complete. The tool then changed nothing.",
"type": "boolean"
},
"next_step": {
"description": "The current module of the customer.",
"type": "string"
},
"status": {
"enum": [
"completed"
],
"type": "string"
},
"waiting_for_partner": {
"description": "Why the next module waits for the partner.",
"type": "string"
}
},
"required": [
"status",
"completed_now",
"app_url"
],
"type": "object"
}
},
{
"description": "Completes the My Family module, as the Complete button of the app does. Call it only when the customer says that the list of family members is complete. First call list_family_members, and show the customer the full list of family members. Then show this exact statement, and get an explicit yes: \"I have shared a complete version of my family members.\" Then call with confirm true. The completion can open the next module. Give the customer next_step.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirm": {
"description": "True only after the customer said yes to the statement of the description.",
"enum": [
true
],
"type": "boolean"
},
"expected_module_state": {
"description": "The module_state that you read from the list or describe tool of this module, also when it is open. When the state is now different, the tool saves nothing and gives the new state.",
"enum": [
"open",
"edit_restarts_alignment",
"closed"
],
"type": "string"
}
},
"required": [
"confirm"
],
"type": "object"
},
"name": "complete_my_family",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"app_url": {
"description": "The dashboard of the app.",
"type": "string"
},
"completed_now": {
"description": "False when the module was already complete. The tool then changed nothing.",
"type": "boolean"
},
"next_step": {
"description": "The current module of the customer.",
"type": "string"
},
"status": {
"enum": [
"completed"
],
"type": "string"
},
"waiting_for_partner": {
"description": "Why the next module waits for the partner.",
"type": "string"
}
},
"required": [
"status",
"completed_now",
"app_url"
],
"type": "object"
}
},
{
"description": "Deletes one of the customer's own assets or debts. Take the id and the module_state from list_assets. Confirm the delete with the customer before you call this tool: the asset cannot be restored. When module_state is edit_restarts_alignment, also tell the customer that the delete restarts the alignment of the couple and can email the partner, and get a yes. After an asset, family, or allocation write, tell the customer that the alignment restarted when alignment_restarted is true. Tell the customer that the partner got an email when partner_emailed is true. When a value is false, say nothing about it. When the customer asks about these values, answer from the results of all the writes in this conversation. Send the module_state that you read as expected_module_state, also when it is open.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"expected_module_state": {
"description": "The module_state that you read from the list or describe tool of this module, also when it is open. When the state is now different, the tool saves nothing and gives the new state.",
"enum": [
"open",
"edit_restarts_alignment",
"closed"
],
"type": "string"
},
"id": {
"description": "The id from the list tool. Only an own row of the customer.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "delete_asset",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"alignment_restarted": {
"description": "True when the write restarted the alignment of the couple.",
"type": "boolean"
},
"app_url": {
"type": "string"
},
"id": {
"type": "string"
},
"partner_emailed": {
"description": "True when the partner got an email that the alignment restarted.",
"type": "boolean"
},
"status": {
"enum": [
"deleted"
],
"type": "string"
}
},
"required": [
"status",
"id",
"app_url",
"alignment_restarted",
"partner_emailed"
],
"type": "object"
}
},
{
"description": "Deletes one of the customer's own dependents or pets. Take the id and the module_state from list_family_members. Confirm the delete with the customer before you call this tool: the family member cannot be restored. When module_state is edit_restarts_alignment, also tell the customer that the delete restarts the alignment of the couple and can email the partner, and get a yes. After an asset, family, or allocation write, tell the customer that the alignment restarted when alignment_restarted is true. Tell the customer that the partner got an email when partner_emailed is true. When a value is false, say nothing about it. When the customer asks about these values, answer from the results of all the writes in this conversation. Send the module_state that you read as expected_module_state, also when it is open.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"expected_module_state": {
"description": "The module_state that you read from the list or describe tool of this module, also when it is open. When the state is now different, the tool saves nothing and gives the new state.",
"enum": [
"open",
"edit_restarts_alignment",
"closed"
],
"type": "string"
},
"id": {
"description": "The id from the list tool. Only an own row of the customer.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "delete_family_member",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"alignment_restarted": {
"description": "True when the write restarted the alignment of the couple.",
"type": "boolean"
},
"app_url": {
"type": "string"
},
"id": {
"type": "string"
},
"partner_emailed": {
"description": "True when the partner got an email that the alignment restarted.",
"type": "boolean"
},
"status": {
"enum": [
"deleted"
],
"type": "string"
}
},
"required": [
"status",
"id",
"app_url",
"alignment_restarted",
"partner_emailed"
],
"type": "object"
}
},
{
"description": "Returns the form of one kind of asset or debt on the My Assets page: the field keys, the labels, the options, the required fields, and the module_state. Call it before add_asset or update_asset. When module_state is closed, do not collect values: give the customer next_step_url. Otherwise ask the customer for each required value. For a bank account, a credit card, an investment, or a debt, when the result gives plaid_connection_url (for example /prenup/my-assets/bank), offer two choices: the customer connects the account through Plaid in the app, or gives the account here for add_asset. A Plaid connection in the app also restarts the alignment when module_state is edit_restarts_alignment, so get the same yes first. Never ask for the sign-in details of an account.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"kind": {
"description": "The kind of asset or debt.",
"enum": [
"bank",
"creditCard",
"investment",
"loan",
"retirement",
"vehicle",
"realEstate",
"business",
"other",
"intangible",
"trust",
"jewelry",
"collectible",
"crypto",
"cash",
"socialMediaAccount",
"militaryBenefits",
"inheritanceReceived"
],
"type": "string"
}
},
"required": [
"kind"
],
"type": "object"
},
"name": "describe_asset_form",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"fields": {
"items": {
"type": "object"
},
"type": "array"
},
"kind": {
"type": "string"
},
"module_state": {
"description": "The state of the module for a write of the customer. open: a write saves. edit_restarts_alignment: a write saves, restarts the alignment of the couple, and can email the partner. Tell the customer this and get a yes before the write. closed: the tools refuse a write. Do not collect values. Give the customer next_step_url.",
"enum": [
"open",
"edit_restarts_alignment",
"closed"
],
"type": "string"
},
"next_step_url": {
"description": "Only for a closed module: the app page that shows the next step.",
"type": "string"
},
"notes": {
"type": "string"
},
"plaid_connection_url": {
"description": "Only for a bank, a credit card, an investment, or a debt when the module is not closed: the app page that connects the account through Plaid. It needs a computer: the app does not show My Assets on a phone.",
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"kind",
"title",
"fields",
"notes",
"module_state"
],
"type": "object"
}
},
{
"description": "Returns the form of a dependent or a pet on the My Family page: the field keys, the labels, the options, the required fields, and the module_state. Call it before add_family_member or update_family_member. When module_state is closed, do not collect values: give the customer next_step_url. Otherwise ask the customer for each required value.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"kind": {
"description": "dependent or pet.",
"enum": [
"dependent",
"pet"
],
"type": "string"
}
},
"required": [
"kind"
],
"type": "object"
},
"name": "describe_family_form",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"fields": {
"items": {
"type": "object"
},
"type": "array"
},
"kind": {
"type": "string"
},
"module_state": {
"description": "The state of the module for a write of the customer. open: a write saves. edit_restarts_alignment: a write saves, restarts the alignment of the couple, and can email the partner. Tell the customer this and get a yes before the write. closed: the tools refuse a write. Do not collect values. Give the customer next_step_url.",
"enum": [
"open",
"edit_restarts_alignment",
"closed"
],
"type": "string"
},
"next_step_url": {
"description": "Only for a closed module: the app page that shows the next step.",
"type": "string"
},
"notes": {
"type": "string"
},
"plaid_connection_url": {
"description": "Only for a bank, a credit card, an investment, or a debt when the module is not closed: the app page that connects the account through Plaid. It needs a computer: the app does not show My Assets on a phone.",
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"kind",
"title",
"fields",
"notes",
"module_state"
],
"type": "object"
}
},
{
"description": "Finishes the welcome steps of a paid product, as the dashboard of the First app does. It saves the acceptance of the statements of welcome.confirm from get_started, and the optional phone. Call it only at the onboarding stage. First show each statement, and get an explicit yes to each one from the customer. Then invite the partner with invite_partner when the next step of get_started asks for it. Returns the next setup step, as get_started does.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"accept_terms": {
"description": "True only after the customer said yes to the statement about the Terms of Service and the Privacy Policy.",
"enum": [
true
],
"type": "boolean"
},
"acknowledge_signing": {
"description": "The prenup and the postnup only. True only after the customer said yes to the statement about the signature.",
"enum": [
true
],
"type": "boolean"
},
"phone": {
"description": "The customer's US phone number, for texts about the service.",
"type": "string"
},
"product": {
"description": "The product line of the welcome steps.",
"enum": [
"prenup",
"babynup"
],
"type": "string"
},
"skip_phone": {
"description": "True when the customer declines to give a phone. The app then does not ask again. Leave out phone and skip_phone when you did not ask.",
"enum": [
true
],
"type": "boolean"
}
},
"required": [
"product",
"accept_terms"
],
"type": "object"
},
"name": "finish_welcome_steps",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"app_url": {
"type": "string"
},
"can_do": {
"type": "string"
},
"choices": {
"items": {
"type": "string"
},
"type": "array"
},
"current_step": {
"type": "string"
},
"first_name": {
"type": "string"
},
"next_step": {
"type": "string"
},
"product": {
"type": "string"
},
"products": {
"items": {
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"product": {
"type": "string"
}
},
"required": [
"product",
"name",
"description"
],
"type": "object"
},
"type": "array"
},
"stage": {
"enum": [
"invite",
"choose",
"profile",
"eligibility",
"package",
"payment",
"onboarding",
"partner",
"modules"
],
"type": "string"
},
"status": {
"type": "string"
},
"waiting_for_partner": {
"type": "string"
},
"waiting_period_days_left": {
"type": "integer"
},
"welcome": {
"properties": {
"confirm": {
"properties": {
"note": {
"type": "string"
},
"statements": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"statements"
],
"type": "object"
},
"how_it_works": {
"items": {
"properties": {
"text": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"title",
"text"
],
"type": "object"
},
"type": "array"
},
"phone": {
"properties": {
"consent": {
"type": "string"
},
"purpose": {
"type": "string"
}
},
"required": [
"purpose",
"consent"
],
"type": "object"
}
},
"required": [
"how_it_works",
"confirm"
],
"type": "object"
}
},
"required": [
"stage",
"next_step",
"can_do"
],
"type": "object"
}
},
{
"description": "Returns where the customer is in their First agreement: the status, the waiting period when there is one, the current step in the app, and a link to the app. Before the account setup is done, it returns the setup stage and the next step, as get_started does. Do not use it for questions about how First or the law works.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"product": {
"description": "The product that the customer chose, or the product line of the agreement. Send it in each call until the customer has an agreement of this product.",
"enum": [
"prenup",
"babynup"
],
"type": "string"
}
},
"type": "object"
},
"name": "get_agreement_status",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"app_url": {
"type": "string"
},
"can_do": {
"type": "string"
},
"current_step": {
"type": "string"
},
"first_name": {
"type": "string"
},
"next_step": {
"type": "string"
},
"product": {
"type": "string"
},
"products": {
"items": {
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"product": {
"type": "string"
}
},
"required": [
"product",
"name",
"description"
],
"type": "object"
},
"type": "array"
},
"stage": {
"type": "string"
},
"status": {
"type": "string"
},
"waiting_for_partner": {
"type": "string"
},
"waiting_period_days_left": {
"type": "integer"
},
"welcome": {
"properties": {
"confirm": {
"properties": {
"note": {
"type": "string"
},
"statements": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"statements"
],
"type": "object"
},
"how_it_works": {
"items": {
"properties": {
"text": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"title",
"text"
],
"type": "object"
},
"type": "array"
},
"phone": {
"properties": {
"consent": {
"type": "string"
},
"purpose": {
"type": "string"
}
},
"required": [
"purpose",
"consent"
],
"type": "object"
}
},
"required": [
"how_it_works",
"confirm"
],
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Returns the alignment steps of the prenup with the status of the customer and of the partner, the current step, and the data of a step as its app page shows it. The steps go in this order: financial-views (the customer agrees with the partner on each financial view), partners-premarital-property (the customer reads the premarital property of the partner), partners-postmarital-property (the customer agrees or disagrees with each postmarital allocation of the partner), and postmarital-property (the customer sees the review of the partner, and picks again where the partner disagrees). Give step to read a different step, or premarital-property or shared-property for the own premarital assets and the shared assets. Each asset and item gives its allocation in separate_property, as the page shows it. When ready_to_complete is true, the customer can complete alignment with complete_alignment. changed_after_completion names the sections that a partner changed after their completion. Tell the customer about them before a write of financial-views: the write clears the list, as the page does when it opens. Show the data to the customer before each write of the step. A question with in_app true changes only in the app: give the customer its app_url.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"step": {
"description": "The step or the page to read. Leave it out for the current step.",
"enum": [
"financial-views",
"partners-premarital-property",
"partners-postmarital-property",
"postmarital-property",
"premarital-property",
"shared-property"
],
"type": "string"
}
},
"type": "object"
},
"name": "get_alignment",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"allocation_labels": {
"description": "The words of the app for separate_property true and false.",
"type": "object"
},
"app_url": {
"type": "string"
},
"changed_after_completion": {
"description": "The titles of the sections that the customer or the partner changed after their completion. The title of a partner section speaks to the partner.",
"properties": {
"customer": {
"items": {
"type": "string"
},
"type": "array"
},
"partner": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"complete_statement": {
"description": "Only when ready_to_complete is true, for Lawyer Review: show it before complete_alignment, and get an explicit yes.",
"type": "string"
},
"current_step": {
"description": "The first step that the customer can do now.",
"type": "string"
},
"data": {
"description": "The data of shown_step, as its app page shows it.",
"type": "object"
},
"ready_to_complete": {
"description": "Each step is complete for both partners.",
"type": "boolean"
},
"shown_step": {
"description": "The step or the page of data.",
"type": "string"
},
"steps": {
"items": {
"properties": {
"partner_status": {
"type": "string"
},
"status": {
"type": "string"
},
"step": {
"type": "string"
},
"title": {
"type": "string"
},
"waits_for_partner": {
"type": "boolean"
}
},
"required": [
"step",
"title",
"status",
"partner_status",
"waits_for_partner"
],
"type": "object"
},
"type": "array"
},
"waiting_for_partner": {
"description": "Why the customer waits for the partner.",
"type": "string"
}
},
"required": [
"steps",
"allocation_labels",
"ready_to_complete",
"app_url"
],
"type": "object"
}
},
{
"description": "Returns the customer's First account details: the legal name, the email, the phone, the partner or the partner invite, and the purchases. Use it when the customer asks about these details. Do not use the email of the AI app account. To change the name, call update_profile. To change the phone, call update_phone. To change a pending partner invite, call update_partner_invite. To change the email, call request_email_change.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {},
"type": "object"
},
"name": "get_my_details",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"app_url": {
"type": "string"
},
"email": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"partner": {
"properties": {
"email": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"status": {
"description": "joined: only the partner changes the partner details.",
"enum": [
"joined",
"invited",
"declined"
],
"type": "string"
}
},
"required": [
"email",
"status"
],
"type": "object"
},
"pending_email": {
"description": "A new email that the customer did not verify yet.",
"type": "string"
},
"phone": {
"type": "string"
},
"purchases": {
"items": {
"properties": {
"amount_paid": {
"type": "string"
},
"paid_on": {
"type": "string"
},
"product": {
"type": "string"
},
"product_line": {
"type": "string"
},
"rush_add_on": {
"type": "boolean"
}
},
"required": [
"product",
"product_line",
"paid_on",
"rush_add_on"
],
"type": "object"
},
"type": "array"
},
"requested_email": {
"description": "A new email of request_email_change that the current email did not approve yet.",
"type": "string"
}
},
"required": [
"email",
"purchases",
"app_url"
],
"type": "object"
}
},
{
"description": "Returns the current question of a quiz module of the customer: the text, the options with their ids, the format of the answer, the saved answer, and the progress. Ask the customer the question, then call answer_quiz_question. The result can include notes: the text of the information screens before the question. Give the notes to the customer. This tool saves no answer, but it moves the quiz past the information screens. A result with status allocation gives items that the customer picks one by one with set_allocation. A result with status in_app is a question that the customer answers in the app, at app_url. A result with status complete means that the module is finished. For the eligibility quiz, give the customer next_step and app_url of a result with status complete or ineligible.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"module_slug": {
"description": "The slug of the quiz module, for example basic-information or financial-philosophy. Use eligibility, with product, for the eligibility questions before payment.",
"type": "string"
},
"product": {
"description": "The product line. Send it for the eligibility questions, and when the customer has more than one paid agreement.",
"enum": [
"prenup",
"babynup"
],
"type": "string"
}
},
"required": [
"module_slug"
],
"type": "object"
},
"name": "get_quiz_question",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"allocation_kind": {
"enum": [
"asset",
"marital_property"
],
"type": "string"
},
"answer_format": {
"type": "string"
},
"app_url": {
"type": "string"
},
"body": {
"type": "string"
},
"educational_copy": {
"type": "object"
},
"field_label": {
"type": "string"
},
"items": {
"description": "The items of an allocation question. picked is false until the customer picks.",
"items": {
"type": "object"
},
"type": "array"
},
"kind": {
"type": "string"
},
"module_slug": {
"type": "string"
},
"module_state": {
"description": "The state of the module for a write of the customer. open: a write saves. edit_restarts_alignment: a write saves, restarts the alignment of the couple, and can email the partner. Tell the customer this and get a yes before the write. closed: the tools refuse a write. Do not collect values. Give the customer next_step_url.",
"enum": [
"open",
"edit_restarts_alignment",
"closed"
],
"type": "string"
},
"next_step": {
"type": "string"
},
"next_step_url": {
"description": "Only for a closed module: the app page that shows the next step.",
"type": "string"
},
"notes": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"pets": {
"items": {
"type": "object"
},
"type": "array"
},
"progress": {
"type": "integer"
},
"question_id": {
"type": "string"
},
"saved_answer": {
"type": "object"
},
"status": {
"enum": [
"question",
"allocation",
"in_app",
"complete",
"ineligible"
],
"type": "string"
},
"subtitle": {
"type": "string"
},
"title": {
"type": "string"
},
"waiting_for_partner": {
"type": "string"
}
},
"required": [
"status",
"module_slug",
"app_url"
],
"type": "object"
}
},
{
"description": "Returns the customer's first name, the setup stage of their First account, and the one next step. It also says what the assistant can do now. After the setup, it gives the status of the agreement. At the onboarding stage, it gives the welcome steps to do in the chat. Call it at the first message of a conversation, also when that message is only a greeting. Greet the customer by first name. Before the setup is done, it gives choices. When the message of the customer is only a greeting, offer the choices of get_started one time in the conversation and wait for the answer, or give the next step when there are no choices. When the message is not only a greeting, answer it, and give the next step when the customer asks what to do. A customer with no agreement gets the products to choose from: ask the customer to start one, or to only ask Clara questions.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"product": {
"description": "The product that the customer chose, or the product line of the agreement. Send it in each call until the customer has an agreement of this product.",
"enum": [
"prenup",
"babynup"
],
"type": "string"
}
},
"type": "object"
},
"name": "get_started",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"app_url": {
"type": "string"
},
"can_do": {
"type": "string"
},
"choices": {
"items": {
"type": "string"
},
"type": "array"
},
"current_step": {
"type": "string"
},
"first_name": {
"type": "string"
},
"next_step": {
"type": "string"
},
"product": {
"type": "string"
},
"products": {
"items": {
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"product": {
"type": "string"
}
},
"required": [
"product",
"name",
"description"
],
"type": "object"
},
"type": "array"
},
"stage": {
"enum": [
"invite",
"choose",
"profile",
"eligibility",
"package",
"payment",
"onboarding",
"partner",
"modules"
],
"type": "string"
},
"status": {
"type": "string"
},
"waiting_for_partner": {
"type": "string"
},
"waiting_period_days_left": {
"type": "integer"
},
"welcome": {
"properties": {
"confirm": {
"properties": {
"note": {
"type": "string"
},
"statements": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"statements"
],
"type": "object"
},
"how_it_works": {
"items": {
"properties": {
"text": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"title",
"text"
],
"type": "object"
},
"type": "array"
},
"phone": {
"properties": {
"consent": {
"type": "string"
},
"purpose": {
"type": "string"
}
},
"required": [
"purpose",
"consent"
],
"type": "object"
}
},
"required": [
"how_it_works",
"confirm"
],
"type": "object"
}
},
"required": [
"stage",
"next_step",
"can_do"
],
"type": "object"
}
},
{
"description": "Sends an invite email from First to the customer's partner, so the partner can join the agreement. Confirm the partner's name and email with the customer before you call this tool. When an invite is already pending, call resend_partner_invite to send it again, or update_partner_invite to change the email.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"email": {
"description": "The partner's email address.",
"type": "string"
},
"first_name": {
"description": "The partner's first name.",
"maxLength": 50,
"minLength": 1,
"pattern": "\\S",
"type": "string"
},
"last_name": {
"description": "The partner's last name.",
"maxLength": 50,
"minLength": 1,
"pattern": "\\S",
"type": "string"
}
},
"required": [
"email",
"first_name",
"last_name"
],
"type": "object"
},
"name": "invite_partner",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"app_url": {
"type": "string"
},
"next_step": {
"type": "string"
},
"status": {
"enum": [
"sent",
"updated"
],
"type": "string"
}
},
"required": [
"status",
"next_step",
"app_url"
],
"type": "object"
}
},
{
"description": "Returns the assets and debts on the customer's My Assets page, with their ids: the customer's own assets and the assets that the partner shares. Use it for the exact list or an id. Call ask_clara for questions about what the assets mean for the prenup. module_state tells if a write saves, restarts the alignment, or gets a refusal. When it is closed, give the customer next_step_url.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {},
"type": "object"
},
"name": "list_assets",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"app_url": {
"type": "string"
},
"assets": {
"items": {
"properties": {
"currency": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"enum": [
"customer",
"partner"
],
"type": "string"
},
"separate_property": {
"type": "boolean"
},
"shared": {
"type": "boolean"
},
"subkind": {
"type": "string"
},
"value": {
"description": "In the currency. A debt has a negative value. An intellectual property or social media asset has no value, as in the agreement.",
"type": "number"
}
},
"required": [
"id",
"kind",
"subkind",
"name",
"currency",
"owner",
"shared",
"separate_property"
],
"type": "object"
},
"type": "array"
},
"module_state": {
"description": "The state of the module for a write of the customer. open: a write saves. edit_restarts_alignment: a write saves, restarts the alignment of the couple, and can email the partner. Tell the customer this and get a yes before the write. closed: the tools refuse a write. Do not collect values. Give the customer next_step_url.",
"enum": [
"open",
"edit_restarts_alignment",
"closed"
],
"type": "string"
},
"next_step_url": {
"description": "Only for a closed module: the app page that shows the next step.",
"type": "string"
}
},
"required": [
"assets",
"app_url",
"module_state"
],
"type": "object"
}
},
{
"description": "Lists the customer's own documents, for example the prenup summary and the waivers: the kind, the title, whether the customer agreed, the date of the signature, and a link to the app. Some documents are only in the app. Call read_document with the kind for the text. The customer agrees to and signs a document only in the app.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"product": {
"description": "The product line of the agreement. Leave it out when only one agreement is paid.",
"enum": [
"prenup",
"babynup"
],
"type": "string"
}
},
"type": "object"
},
"name": "list_documents",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"app_url": {
"type": "string"
},
"documents": {
"items": {
"properties": {
"agree": {
"type": "boolean"
},
"app_url": {
"type": "string"
},
"description": {
"type": "string"
},
"kind": {
"type": "string"
},
"signed_at": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"kind",
"title",
"agree",
"app_url"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"documents",
"app_url"
],
"type": "object"
}
},
{
"description": "Returns the dependents and pets on the customer's My Family page, with their ids: the customer's own family members and the members that the partner shares. Use it for the exact list or an id. Call ask_clara for questions about what the family members mean for the prenup. module_state tells if a write saves, restarts the alignment, or gets a refusal. When it is closed, give the customer next_step_url.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {},
"type": "object"
},
"name": "list_family_members",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"app_url": {
"type": "string"
},
"family_members": {
"items": {
"properties": {
"id": {
"type": "string"
},
"kind": {
"enum": [
"dependent",
"pet"
],
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"enum": [
"customer",
"partner"
],
"type": "string"
},
"shared": {
"type": "boolean"
},
"subkind": {
"type": "string"
}
},
"required": [
"id",
"kind",
"subkind",
"name",
"owner",
"shared"
],
"type": "object"
},
"type": "array"
},
"module_state": {
"description": "The state of the module for a write of the customer. open: a write saves. edit_restarts_alignment: a write saves, restarts the alignment of the couple, and can email the partner. Tell the customer this and get a yes before the write. closed: the tools refuse a write. Do not collect values. Give the customer next_step_url.",
"enum": [
"open",
"edit_restarts_alignment",
"closed"
],
"type": "string"
},
"next_step_url": {
"description": "Only for a closed module: the app page that shows the next step.",
"type": "string"
}
},
"required": [
"family_members",
"app_url",
"module_state"
],
"type": "object"
}
},
{
"description": "Moves a quiz module back one question, as the Back button of the app does, and returns that question. It saves no answer, and it changes only the position in the quiz. Use it when the customer wants to change an earlier answer.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"module_slug": {
"description": "The slug of the quiz module, for example basic-information or financial-philosophy. Use eligibility, with product, for the eligibility questions before payment.",
"type": "string"
},
"product": {
"description": "The product line. Send it for the eligibility questions, and when the customer has more than one paid agreement.",
"enum": [
"prenup",
"babynup"
],
"type": "string"
}
},
"required": [
"module_slug"
],
"type": "object"
},
"name": "previous_quiz_question",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"allocation_kind": {
"enum": [
"asset",
"marital_property"
],
"type": "string"
},
"answer_format": {
"type": "string"
},
"app_url": {
"type": "string"
},
"body": {
"type": "string"
},
"educational_copy": {
"type": "object"
},
"field_label": {
"type": "string"
},
"items": {
"description": "The items of an allocation question. picked is false until the customer picks.",
"items": {
"type": "object"
},
"type": "array"
},
"kind": {
"type": "string"
},
"module_slug": {
"type": "string"
},
"module_state": {
"description": "The state of the module for a write of the customer. open: a write saves. edit_restarts_alignment: a write saves, restarts the alignment of the couple, and can email the partner. Tell the customer this and get a yes before the write. closed: the tools refuse a write. Do not collect values. Give the customer next_step_url.",
"enum": [
"open",
"edit_restarts_alignment",
"closed"
],
"type": "string"
},
"next_step": {
"type": "string"
},
"next_step_url": {
"description": "Only for a closed module: the app page that shows the next step.",
"type": "string"
},
"notes": {
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"items": {
"type": "object"
},
"type": "array"
},
"pets": {
"items": {
"type": "object"
},
"type": "array"
},
"progress": {
"type": "integer"
},
"question_id": {
"type": "string"
},
"saved_answer": {
"type": "object"
},
"status": {
"enum": [
"question",
"allocation",
"in_app",
"complete",
"ineligible"
],
"type": "string"
},
"subtitle": {
"type": "string"
},
"title": {
"type": "string"
},
"waiting_for_partner": {
"type": "string"
}
},
"required": [
"status",
"module_slug",
"app_url"
],
"type": "object"
}
},
{
"description": "Returns the text of the customer's agreement, as the agreement page of the app shows it. Send search to get only the parts around a word or phrase, for example \"house\". Leave search out to read the whole agreement, for example for a question about the agreement as a whole. A long agreement comes in pages: call again with the next page until page equals pages.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"page": {
"description": "The page of the whole text. The first is 1.",
"minimum": 1,
"type": "integer"
},
"product": {
"description": "The product line of the agreement. Leave it out when only one agreement is paid.",
"enum": [
"prenup",
"babynup"
],
"type": "string"
},
"search": {
"description": "A word or phrase. The result has up to 10 excerpts around the matches, not a page.",
"pattern": "\\S",
"type": "string"
}
},
"type": "object"
},
"name": "read_agreement",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"app_url": {
"type": "string"
},
"excerpts": {
"description": "Empty when nothing matches.",
"items": {
"type": "string"
},
"type": "array"
},
"more_matches": {
"description": "The agreement has more matches. Send a narrower search, or read the pages.",
"type": "boolean"
},
"page": {
"type": "integer"
},
"pages": {
"type": "integer"
},
"product": {
"type": "string"
},
"text": {
"description": "A page of the agreement, when the call has no search.",
"type": "string"
}
},
"required": [
"product",
"app_url"
],
"type": "object"
}
},
{
"description": "Returns the text of one of the customer's own documents, for example the prenup summary. Call list_documents for the kinds that the customer has.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"kind": {
"description": "The kind from list_documents.",
"enum": [
"retention_agreement",
"advisory_letter",
"lawyer_review_questions",
"waiver_of_attorney",
"prenup_summary",
"affirmation_of_waiver_of_pension_rights",
"property_agreement_between_spouses",
"agreement_to_convert_separate_property_to_community",
"special_warranty_deed",
"waiver_of_further_financial_disclosure"
],
"type": "string"
},
"product": {
"description": "The product line of the agreement. Leave it out when only one agreement is paid.",
"enum": [
"prenup",
"babynup"
],
"type": "string"
}
},
"required": [
"kind"
],
"type": "object"
},
"name": "read_document",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"app_url": {
"type": "string"
},
"kind": {
"type": "string"
},
"text": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"kind",
"title",
"text",
"app_url"
],
"type": "object"
}
},
{
"description": "Asks to change the email that the customer uses to sign in to First. Confirm the new email with the customer before you call this tool. The tool does not change the email: the customer approves the change from the current email, and then confirms the new email from a sign-in link.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"new_email": {
"description": "The new email.",
"type": "string"
}
},
"required": [
"new_email"
],
"type": "object"
},
"name": "request_email_change",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"next_step": {
"type": "string"
},
"status": {
"enum": [
"requested"
],
"type": "string"
}
},
"required": [
"status",
"next_step"
],
"type": "object"
}
},
{
"description": "Sends the pending partner invite again, to the same email. Confirm with the customer before you call this tool. To invite a different email, call update_partner_invite. A partner who declined gets no new invite.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {},
"type": "object"
},
"name": "resend_partner_invite",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"app_url": {
"type": "string"
},
"next_step": {
"type": "string"
},
"status": {
"enum": [
"sent",
"updated"
],
"type": "string"
}
},
"required": [
"status",
"next_step",
"app_url"
],
"type": "object"
}
},
{
"description": "Does one action of the financial-views step of alignment on one question, as the financial views page of the app does. Call get_alignment first: each question gives its actions. acknowledge: the customer read the different answer of the partner and accepts it. Show the answer of the partner first. answer: the customer changes the own answer, in the format of answer_format. Confirm the answer with the customer first. A changed answer asks the partner to review the financial views again. When each question is aligned, complete the step with complete_alignment_step.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"action": {
"enum": [
"acknowledge",
"answer"
],
"type": "string"
},
"option_ids": {
"description": "The selected option ids.",
"items": {
"type": "string"
},
"type": "array"
},
"question_id": {
"description": "The question_id from get_alignment.",
"type": "string"
},
"value": {
"description": "The value of an input question.",
"type": [
"string",
"number"
]
}
},
"required": [
"question_id",
"action"
],
"type": "object"
},
"name": "review_financial_view",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"aligned": {
"description": "Each question of the financial views is aligned.",
"type": "boolean"
},
"app_url": {
"type": "string"
},
"question": {
"description": "The question after the action, as get_alignment gives it. Not given when question_hidden is true.",
"type": "object"
},
"question_hidden": {
"description": "True when the new answer hides the question from the financial views.",
"type": "boolean"
},
"status": {
"enum": [
"saved"
],
"type": "string"
}
},
"required": [
"status",
"question_hidden",
"aligned",
"app_url"
],
"type": "object"
}
},
{
"description": "Saves the review of the customer of the postmarital allocations of the partner, in the partners-postmarital-property step of alignment. Call get_alignment with this step first, and show the customer each item of the partner with its allocation. agree true accepts the allocation of the partner. agree false disagrees: the partner then picks again. Give an item for each item that has no review (customer_agrees null), in one call. Give the separate_property of each item as get_alignment gave it. When an item changed after the read, the tool saves nothing: read the step again, and show the new allocation to the customer. An item that you do not give keeps its review. Then complete the step with complete_alignment_step.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"items": {
"items": {
"additionalProperties": false,
"properties": {
"agree": {
"type": "boolean"
},
"id": {
"description": "The id of a partner item from get_alignment.",
"type": "string"
},
"separate_property": {
"description": "The separate_property of the item that the customer saw in get_alignment.",
"type": "boolean"
}
},
"required": [
"id",
"agree",
"separate_property"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
},
"name": "review_partner_property",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"app_url": {
"type": "string"
},
"partner_items": {
"items": {
"type": "object"
},
"type": "array"
},
"status": {
"enum": [
"saved"
],
"type": "string"
}
},
"required": [
"status",
"partner_items",
"app_url"
],
"type": "object"
}
},
{
"description": "Saves one allocation pick of the customer: keep an item as separate property after the wedding, or share it (allocation_labels of get_alignment give the words of the app). kind asset is an own premarital asset that is not shared (get_alignment step premarital-property). kind marital_property is a category of postmarital property (get_alignment step postmarital-property). After the financial philosophy quiz closed, a pick of kind marital_property needs the step postmarital-property. An allocation question of the financial philosophy quiz gives the items of both kinds. A pick of a postmarital category asks the partner to review it again. Read module_state before the pick. When it is edit_restarts_alignment, tell the customer that the pick restarts the alignment of the couple and can email the partner, and get a yes. Send the module_state that you read as expected_module_state, also when it is open. After an asset, family, or allocation write, tell the customer that the alignment restarted when alignment_restarted is true. Tell the customer that the partner got an email when partner_emailed is true. When a value is false, say nothing about it. When the customer asks about these values, answer from the results of all the writes in this conversation.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"expected_module_state": {
"description": "The module_state that you read for this kind. When the state is now different, the tool saves nothing and gives the new state.",
"enum": [
"open",
"edit_restarts_alignment",
"closed"
],
"type": "string"
},
"id": {
"description": "The id of the asset or of the postmarital category.",
"type": "string"
},
"kind": {
"enum": [
"asset",
"marital_property"
],
"type": "string"
},
"separate_property": {
"description": "True to keep the item separate. False to share it.",
"type": "boolean"
}
},
"required": [
"kind",
"id",
"separate_property"
],
"type": "object"
},
"name": "set_allocation",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"alignment_restarted": {
"description": "True when the write restarted the alignment of the couple.",
"type": "boolean"
},
"app_url": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"partner_emailed": {
"description": "True when the partner got an email that the alignment restarted.",
"type": "boolean"
},
"separate_property": {
"type": "boolean"
},
"status": {
"enum": [
"saved"
],
"type": "string"
}
},
"required": [
"status",
"kind",
"id",
"name",
"separate_property",
"app_url",
"alignment_restarted",
"partner_emailed"
],
"type": "object"
}
},
{
"description": "Changes the fields of one of the customer's own assets or debts. Take the id and the module_state from list_assets. Give only the fields that change. Confirm the change with the customer before you call this tool. When module_state is edit_restarts_alignment, also tell the customer that the change restarts the alignment of the couple and can email the partner, and get a yes. After an asset, family, or allocation write, tell the customer that the alignment restarted when alignment_restarted is true. Tell the customer that the partner got an email when partner_emailed is true. When a value is false, say nothing about it. When the customer asks about these values, answer from the results of all the writes in this conversation. Send the module_state that you read as expected_module_state, also when it is open.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"expected_module_state": {
"description": "The module_state that you read from the list or describe tool of this module, also when it is open. When the state is now different, the tool saves nothing and gives the new state.",
"enum": [
"open",
"edit_restarts_alignment",
"closed"
],
"type": "string"
},
"fields": {
"additionalProperties": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"description": "The values of the form, by the field keys of the describe tool. Give each currency amount in US dollars, with up to 2 decimals. The amount of a debt is positive.",
"minProperties": 1,
"type": "object"
},
"id": {
"description": "The id from the list tool. Only an own row of the customer.",
"type": "string"
}
},
"required": [
"id",
"fields"
],
"type": "object"
},
"name": "update_asset",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"alignment_restarted": {
"description": "True when the write restarted the alignment of the couple.",
"type": "boolean"
},
"app_url": {
"type": "string"
},
"asset": {
"properties": {
"currency": {
"type": "string"
},
"id": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"enum": [
"customer",
"partner"
],
"type": "string"
},
"separate_property": {
"type": "boolean"
},
"shared": {
"type": "boolean"
},
"subkind": {
"type": "string"
},
"value": {
"description": "In the currency. A debt has a negative value. An intellectual property or social media asset has no value, as in the agreement.",
"type": "number"
}
},
"required": [
"id",
"kind",
"subkind",
"name",
"currency",
"owner",
"shared",
"separate_property"
],
"type": "object"
},
"partner_emailed": {
"description": "True when the partner got an email that the alignment restarted.",
"type": "boolean"
},
"status": {
"enum": [
"saved"
],
"type": "string"
}
},
"required": [
"status",
"asset",
"app_url",
"alignment_restarted",
"partner_emailed"
],
"type": "object"
}
},
{
"description": "Changes the fields of one of the customer's own dependents or pets. Take the id and the module_state from list_family_members. Give only the fields that change. Confirm the change with the customer before you call this tool. When module_state is edit_restarts_alignment, also tell the customer that the change restarts the alignment of the couple and can email the partner, and get a yes. After an asset, family, or allocation write, tell the customer that the alignment restarted when alignment_restarted is true. Tell the customer that the partner got an email when partner_emailed is true. When a value is false, say nothing about it. When the customer asks about these values, answer from the results of all the writes in this conversation. Send the module_state that you read as expected_module_state, also when it is open.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"expected_module_state": {
"description": "The module_state that you read from the list or describe tool of this module, also when it is open. When the state is now different, the tool saves nothing and gives the new state.",
"enum": [
"open",
"edit_restarts_alignment",
"closed"
],
"type": "string"
},
"fields": {
"additionalProperties": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"description": "The values of the form, by the field keys of the describe tool. Give each currency amount in US dollars, with up to 2 decimals. The amount of a debt is positive.",
"minProperties": 1,
"type": "object"
},
"id": {
"description": "The id from the list tool. Only an own row of the customer.",
"type": "string"
}
},
"required": [
"id",
"fields"
],
"type": "object"
},
"name": "update_family_member",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"alignment_restarted": {
"description": "True when the write restarted the alignment of the couple.",
"type": "boolean"
},
"app_url": {
"type": "string"
},
"family_member": {
"properties": {
"id": {
"type": "string"
},
"kind": {
"enum": [
"dependent",
"pet"
],
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"enum": [
"customer",
"partner"
],
"type": "string"
},
"shared": {
"type": "boolean"
},
"subkind": {
"type": "string"
}
},
"required": [
"id",
"kind",
"subkind",
"name",
"owner",
"shared"
],
"type": "object"
},
"partner_emailed": {
"description": "True when the partner got an email that the alignment restarted.",
"type": "boolean"
},
"status": {
"enum": [
"saved"
],
"type": "string"
}
},
"required": [
"status",
"family_member",
"app_url",
"alignment_restarted",
"partner_emailed"
],
"type": "object"
}
},
{
"description": "Changes the email or the name of a partner who did not join yet. A new email gets a new invite email from First. Send only the values that change. Confirm them with the customer before you call this tool. When the partner already has a First account, send a new email with both names. After the partner joins, only the partner changes these details.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"email": {
"description": "The partner's new email address.",
"type": "string"
},
"first_name": {
"description": "The partner's first name.",
"maxLength": 50,
"minLength": 1,
"pattern": "\\S",
"type": "string"
},
"last_name": {
"description": "The partner's last name.",
"maxLength": 50,
"minLength": 1,
"pattern": "\\S",
"type": "string"
}
},
"type": "object"
},
"name": "update_partner_invite",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"app_url": {
"type": "string"
},
"next_step": {
"type": "string"
},
"status": {
"enum": [
"sent",
"updated"
],
"type": "string"
}
},
"required": [
"status",
"next_step",
"app_url"
],
"type": "object"
}
},
{
"description": "Saves the customer's US phone number, which First uses for texts about the service. An empty phone removes it. Confirm the number with the customer before you call this tool, and tell the customer: \"By providing your phone number you consent to receiving transactional texts.\" At the welcome steps, send the phone with finish_welcome_steps instead.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"phone": {
"description": "A US phone number with 10 digits, or \"\" to remove it.",
"type": "string"
}
},
"required": [
"phone"
],
"type": "object"
},
"name": "update_phone",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"phone": {
"type": "string"
},
"status": {
"enum": [
"saved",
"removed"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
{
"description": "Saves the customer's full legal name, as on their birth certificate, driver's license, or passport. The name goes into the agreement. Confirm the exact spelling with the customer before you call this tool. Returns the next setup step, as get_started does.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"first_name": {
"description": "The legal first name.",
"maxLength": 50,
"minLength": 1,
"pattern": "\\S",
"type": "string"
},
"last_name": {
"description": "The legal last name.",
"maxLength": 50,
"minLength": 1,
"pattern": "\\S",
"type": "string"
},
"product": {
"description": "The product that the customer chose, or the product line of the agreement. Send it in each call until the customer has an agreement of this product.",
"enum": [
"prenup",
"babynup"
],
"type": "string"
}
},
"required": [
"first_name",
"last_name"
],
"type": "object"
},
"name": "update_profile",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"app_url": {
"type": "string"
},
"can_do": {
"type": "string"
},
"choices": {
"items": {
"type": "string"
},
"type": "array"
},
"current_step": {
"type": "string"
},
"first_name": {
"type": "string"
},
"next_step": {
"type": "string"
},
"product": {
"type": "string"
},
"products": {
"items": {
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"product": {
"type": "string"
}
},
"required": [
"product",
"name",
"description"
],
"type": "object"
},
"type": "array"
},
"stage": {
"enum": [
"invite",
"choose",
"profile",
"eligibility",
"package",
"payment",
"onboarding",
"partner",
"modules"
],
"type": "string"
},
"status": {
"type": "string"
},
"waiting_for_partner": {
"type": "string"
},
"waiting_period_days_left": {
"type": "integer"
},
"welcome": {
"properties": {
"confirm": {
"properties": {
"note": {
"type": "string"
},
"statements": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"statements"
],
"type": "object"
},
"how_it_works": {
"items": {
"properties": {
"text": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"title",
"text"
],
"type": "object"
},
"type": "array"
},
"phone": {
"properties": {
"consent": {
"type": "string"
},
"purpose": {
"type": "string"
}
},
"required": [
"purpose",
"consent"
],
"type": "object"
}
},
"required": [
"how_it_works",
"confirm"
],
"type": "object"
}
},
"required": [
"stage",
"next_step",
"can_do"
],
"type": "object"
}
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:c868645b4784fcce8beec7591394abfe2b72fdc78f8b8019ad5b183a43089652 | sha256sum