{"id":"get_credit_usage","name":"Credit Consumption","alias":"CreditConsumption","aliases":[],"description_short":"Report how much of this project's agent credit allowance is used, daily and monthly, and who used it.","description_long":"\n    Report how far through its agent credit allowance the project is, over both\n    windows that carry one: the day and the calendar month, and how this month's\n    consumption splits between the people and service accounts that caused it.\n\n    The allowance is a project-wide pool shared by every member, not a personal\n    one, and passing it warns rather than blocks: calls keep being served up to a\n    higher ceiling. The per-user breakdown says who drew from that shared pool,\n    as each one's share of the month's consumption. Reading consumption through\n    this agent is itself free and consumes no credits.\n    ","description_tool_prompt":"Report how much of its Botify agent credit allowance the current project has consumed, both for today and for the current calendar month, as a percentage per window with that window's status and reset time, plus a per-user breakdown of this month's consumption ordered from the biggest consumer down. Use when the user asks how much of their allowance or envelope they have used, how many credits they have left, when their credits reset, whether they are close to or over their limit, or who on the project is consuming the credits. Answers in percentages only: the number of credits used, left, or allowed is not reported and must not be inferred or estimated from the percentage. The two kinds of percentage are not comparable and must not be mixed: a window's percentage is of the allowance, while a user's share is of what the project consumed, so the shares sum to 100% whatever the allowance figures say. This agent is free and consumes no credits.","source":"Botify","conversation_examples":["How many Botify credits do we have left this month?","How much of our credit allowance have we used today?","Are we close to our agent credit limit?","When do our credits reset?","Who is using the most credits on this project?","Break down this month's credit consumption per user."],"tags":[],"available_in_chat":true,"available_in_deepthink":true,"available_in_mcp":true,"mcp_audience":"all","config":{"type":"object","properties":{},"required":[]},"item":{"type":"object","properties":{},"required":[]},"response":{"$defs":{"CreditWindow":{"description":"How far through its allowance one window is, and where that stands.","properties":{"usage_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the window's allowance that has been consumed, above 100 once the allowance is passed. Null when there is no allowance to take a share of -- not a statement that calls are blocked","title":"Usage Percent"},"status":{"description":"Where this window's consumption stands, and the only field that says whether calls are still being served: they are refused on ``blocked`` alone","enum":["healthy","warning","over","blocked"],"title":"Status","type":"string"},"resets_at":{"description":"When the window rolls over and consumption returns to 0","format":"date-time","title":"Resets At","type":"string"}},"required":["usage_percent","status","resets_at"],"title":"CreditWindow","type":"object"},"UserConsumption":{"description":"One client's share of what the project spent this month.","properties":{"client_id":{"description":"How the agent recorded the caller, usually the email of the Botify user. A client id no user answers to is a service account, and keeps a null name","title":"Client Id","type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Botify user's full name, null when the client id belongs to no user or to one who filled in neither name","title":"Name"},"share_percent":{"description":"Share of everything the project spent this month that went to this client, as a percentage. A share of the project's own consumption, not of its allowance: these sum to 100 however full the envelope is","title":"Share Percent","type":"number"},"last_activity":{"description":"When this client last spent any of the project's credits","format":"date-time","title":"Last Activity","type":"string"}},"required":["client_id","name","share_percent","last_activity"],"title":"UserConsumption","type":"object"}},"properties":{"credit_status":{"description":"Where the project stands overall: the worse of the daily and the monthly credit status","enum":["healthy","warning","over","blocked"],"title":"Credit Status","type":"string"},"daily":{"$ref":"#/$defs/CreditWindow","description":"Information about the daily allowance usage"},"monthly":{"$ref":"#/$defs/CreditWindow","description":"Information about the monthly allowance usage"},"users":{"description":"The users active on this project this month, biggest share first. Each share is a percentage of what the project consumed, not of its allowance, so they sum to 100 rather than to the monthly usage. Clients whose share rounds to nothing are left out, and the list is empty for a project that has spent nothing this month","items":{"$ref":"#/$defs/UserConsumption"},"title":"Users","type":"array"},"summary":{"description":"A paragraph summarizing where usage sits expressed in natural language","title":"Summary","type":"string"}},"required":["credit_status","daily","monthly","users","summary"],"title":"GetCreditUsageProcessedItem","type":"object"},"has_canvas":false,"open_canvas_automatically":false}