Skip to content

Commit 84274b0

Browse files
Big round of tool name and description updates (#9234)
* Big round of tool name and description updates * PR fixes and format * Apply suggestion from @rachelsaunders Co-authored-by: rachelsaunders <[email protected]> * Apply suggestion from @rachelsaunders Co-authored-by: rachelsaunders <[email protected]> * Apply suggestion from @rachelsaunders Co-authored-by: rachelsaunders <[email protected]> * pr fixes * Formats * format * Update readme after merge; --------- Co-authored-by: rachelsaunders <[email protected]>
1 parent b2dae54 commit 84274b0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+137
-182
lines changed

src/mcp/README.md

Lines changed: 71 additions & 102 deletions
Large diffs are not rendered by default.

src/mcp/resources/guides/init_firestore_rules.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ ${config.readProjectFile("firestore.rules", { fallback: "<FILE DOES NOT EXIST>"
2525
\`\`\`
2626
2727
1. Create the personalData and publicData security rules (seen below). If they have existing \`firestore.rules\`, integrate these with the user's existing rules.
28-
2. Validate & fix the security rules using the \`validate_rules\` tool. Only continue to the next step when the \`validate_rules\` tool succeeds
28+
2. Validate & fix the security rules using the \`firebase_validate_security_rules\` tool. Only continue to the next step when the \`firebase_validate_security_rules\` tool succeeds
2929
3. Update queries in the user's app to use the updated security rules
3030
4. Print the contents of the \`firestore.rules\` file, and then explain what they enforce below them (for example, what changes you've made to the rules, and what actions are allowed / prohibited on each entity). Ask the user for permission to deploy the rules. Do not continue until the user confirms. Deploy the security rules using \`firebase deploy --only firestore\` in the terminal. Do not tell the user to go to the console to deploy rules as this command will do it automatically.
3131

src/mcp/tools/apphosting/fetch_logs.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export const fetch_logs = tool(
1111
{
1212
name: "fetch_logs",
1313
description:
14-
"Fetches the most recent logs for a specified App Hosting backend. If `buildLogs` is specified, the logs from the build process for the latest build are returned. The most recent logs are listed first.",
14+
"Use this to fetch the most recent logs for a specified App Hosting backend. If `buildLogs` is specified, the logs from the build process for the latest build are returned. The most recent logs are listed first.",
1515
inputSchema: z.object({
1616
buildLogs: z
1717
.boolean()

src/mcp/tools/apphosting/list_backends.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export const list_backends = tool(
1515
{
1616
name: "list_backends",
1717
description:
18-
"Retrieves a list of App Hosting backends in the current project. An empty list means that there are no backends. " +
18+
"Use this to retrieve a list of App Hosting backends in the current project. An empty list means that there are no backends. " +
1919
"The `uri` is the public URL of the backend. " +
2020
"A working backend will have a `managed_resources` array that will contain a `run_service` entry. That `run_service.service` " +
2121
"is the resource name of the Cloud Run service serving the App Hosting backend. The last segment of that name is the service ID. " +

src/mcp/tools/auth/get_users.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ import { findUser, listUsers, UserInfo } from "../../../gcp/auth";
55

66
export const get_users = tool(
77
{
8-
name: "auth_get_users",
9-
description: "Retrieves users based on a list of UIDs or a list of emails.",
8+
name: "get_users",
9+
description:
10+
"Use this to retrieve one or more Firebase Auth users based on a list of UIDs or a list of emails.",
1011
inputSchema: z.object({
1112
uids: z.array(z.string()).optional().describe("A list of user UIDs to retrieve."),
1213
emails: z.array(z.string()).optional().describe("A list of user emails to retrieve."),

src/mcp/tools/auth/set_sms_region_policy.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ export const set_sms_region_policy = tool(
77
{
88
name: "set_sms_region_policy",
99
description:
10-
"Sets an SMS Region Policy for Firebase Auth to restrict the regions which can receive text messages based on an ALLOW or DENY list of country codes. This policy will override any existing policies when set.",
10+
"Use this to set an SMS region policy for Firebase Authentication to restrict the regions which can receive text messages based on an ALLOW or DENY list of country codes. This policy will override any existing policies when set.",
1111
inputSchema: z.object({
1212
policy_type: z
1313
.enum(["ALLOW", "DENY"])

src/mcp/tools/auth/update_user.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ import { toggleUserEnablement, setCustomClaim } from "../../../gcp/auth";
66
export const update_user = tool(
77
{
88
name: "update_user",
9-
description:
10-
"Disables, enables a user account or sets a custom claim on a specific user's account. The tool cannot do both at once.",
9+
description: "Use this to disable, enable, or set a custom claim on a specific user's account.",
1110
inputSchema: z.object({
1211
uid: z.string().describe("the UID of the user to update"),
1312
disabled: z.boolean().optional().describe("true disables the user, false enables the user"),

src/mcp/tools/core/create_android_sha.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ function getCertHashType(shaHash: string): string {
1717
export const create_android_sha = tool(
1818
{
1919
name: "create_android_sha",
20-
description: "Adds a SHA certificate hash to an existing Android app.",
20+
description:
21+
"Use this to add the specified SHA certificate hash to the specified Firebase Android App.",
2122
inputSchema: z.object({
2223
app_id: z.string().describe("The Android app ID to add the SHA certificate to."),
2324
sha_hash: z.string().describe("The SHA certificate hash to add (SHA-1 or SHA-256)."),

src/mcp/tools/core/create_app.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ const CREATE_APP_OUTUT_SUFFIX =
1010
export const create_app = tool(
1111
{
1212
name: "create_app",
13-
description: "Creates a new app in your Firebase project for Web, iOS, or Android.",
13+
description:
14+
"Use this to create a new Firebase App in the currently active Firebase Project. Firebase Apps can be iOS, Android, or Web.",
1415
inputSchema: z.object({
1516
display_name: z
1617
.string()

src/mcp/tools/core/create_project.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ async function checkCloudProject(projectId: string): Promise<ProjectInfo | undef
2727
export const create_project = tool(
2828
{
2929
name: "create_project",
30-
description: "Creates a new Firebase project.",
30+
description: "Use this to create a new Firebase Project.",
3131
inputSchema: z.object({
3232
project_id: z.string().describe("The project ID to create or use."),
3333
display_name: z

0 commit comments

Comments
 (0)