Skip to content

Commit 0833c4b

Browse files
Adhere to naming guidelines (#88)
1 parent 5b29944 commit 0833c4b

17 files changed

Lines changed: 67 additions & 41 deletions

.env.sample

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Sample environment file for integration tests
22
# Copy this to .env and fill in your actual values
33

4-
# TigerData API credentials for integration testing
4+
# Tiger Cloud API credentials for integration testing
55
TIGER_PUBLIC_KEY_INTEGRATION=your-public-key-here
66
TIGER_SECRET_KEY_INTEGRATION=your-secret-key-here
77
TIGER_PROJECT_ID_INTEGRATION=your-project-id-here

.goreleaser.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,12 @@ archives:
5555
nfpms:
5656
- id: packages
5757
package_name: tiger-cli
58-
vendor: Timescale, Inc., d/b/a TigerData
58+
vendor: Timescale, Inc., d/b/a Tiger Data
5959
homepage: https://github.com/timescale/tiger-cli
60-
maintainer: TigerData <support@tigerdata.com>
60+
maintainer: Tiger Data <support@tigerdata.com>
6161
description: |-
62-
Tiger CLI - TigerData Cloud Platform CLI
63-
Command-line interface for managing TigerData Cloud Platform resources
62+
Tiger CLI - Tiger Cloud Platform CLI
63+
Command-line interface for managing Tiger Cloud platform resources
6464
license: Apache-2.0
6565
formats:
6666
- deb
@@ -109,8 +109,8 @@ homebrew_casks:
109109
token: "{{ .Env.TAP_GITHUB_TOKEN }}"
110110
homepage: https://github.com/timescale/tiger-cli
111111
description: |-
112-
Tiger CLI - TigerData Cloud Platform CLI
113-
Command-line interface for managing TigerData Cloud Platform resources
112+
Tiger CLI - Tiger Cloud Platform CLI
113+
Command-line interface for managing Tiger Cloud platform resources
114114
binary: tiger
115115
license: Apache-2.0
116116
skip_upload: auto # Skips prerelease builds

CLAUDE.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,32 @@
22

33
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
44

5+
## Naming Guidelines
6+
7+
When writing or updating documentation, code comments, CLI output, error messages, or any other user-facing text, use these official naming conventions:
8+
9+
### Official Names
10+
11+
- **Company Name**: "Tiger Data" (two words, with space)
12+
- **Cloud Platform**: "Tiger Cloud" (NOT "TigerData Cloud" or "TigerData Cloud Platform")
13+
- **CLI Tool**: "Tiger CLI"
14+
- **MCP Server**: "Tiger MCP"
15+
- **API References**: "Tiger Cloud API" (NOT "TigerData API")
16+
17+
### Examples
18+
19+
**Correct Usage:**
20+
- "Tiger CLI is a command-line interface for managing Tiger Cloud platform resources."
21+
- "Authenticate with Tiger Cloud API"
22+
- "List all database services in your Tiger Cloud project."
23+
- "The Tiger MCP server provides programmatic access to Tiger Cloud."
24+
25+
**Incorrect Usage:**
26+
- ~~"TigerData Cloud Platform"~~ → Use "Tiger Cloud platform"
27+
- ~~"TigerData API"~~ → Use "Tiger Cloud API"
28+
- ~~"TigerData project"~~ → Use "Tiger Cloud project"
29+
- ~~"TigerData MCP"~~ → Use "Tiger MCP"
30+
531
## Development Commands
632

733
### Building
@@ -435,7 +461,7 @@ func buildRootCmd() *cobra.Command {
435461

436462
cmd := &cobra.Command{
437463
Use: "tiger",
438-
Short: "Tiger CLI - TigerData Cloud Platform command-line interface",
464+
Short: "Tiger CLI - Tiger Cloud Platform command-line interface",
439465
Long: `Complete CLI description...`,
440466
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
441467
// Use local flag variables in scope

docs/mcp_feedback.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# TigerData MCP Feedback
1+
# Tiger MCP Feedback
22

33
## Overall Assessment
4-
The TigerData MCP tools provide useful database management functionality but have several areas for improvement in naming consistency, parameter documentation, and descriptions.
4+
The Tiger MCP tools provide useful database management functionality but have several areas for improvement in naming consistency, parameter documentation, and descriptions.
55

66
## Tool Names
77

internal/tiger/cmd/auth.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ func buildLoginCmd() *cobra.Command {
3636

3737
cmd := &cobra.Command{
3838
Use: "login",
39-
Short: "Authenticate with TigerData API",
40-
Long: `Authenticate with TigerData API using predefined keys or an interactive OAuth flow
39+
Short: "Authenticate with Tiger Cloud API",
40+
Long: `Authenticate with Tiger Cloud API using predefined keys or an interactive OAuth flow
4141
4242
By default, the command will launch an interactive OAuth flow in your browser to create new API keys.
4343
The OAuth flow will:
@@ -191,7 +191,7 @@ func buildAuthCmd() *cobra.Command {
191191
cmd := &cobra.Command{
192192
Use: "auth",
193193
Short: "Manage authentication and credentials",
194-
Long: `Manage authentication and credentials for TigerData Cloud Platform.`,
194+
Long: `Manage authentication and credentials for Tiger Cloud platform.`,
195195
}
196196

197197
cmd.AddCommand(buildLoginCmd())

internal/tiger/cmd/mcp.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ func buildMCPCmd() *cobra.Command {
2121
Short: "Tiger Model Context Protocol (MCP) server",
2222
Long: `Tiger Model Context Protocol (MCP) server for AI assistant integration.
2323
24-
The MCP server provides programmatic access to TigerData Cloud Platform resources
24+
The MCP server provides programmatic access to Tiger Cloud platform resources
2525
through Claude and other AI assistants. It exposes Tiger CLI functionality as MCP
2626
tools that can be called by AI agents.
2727
@@ -120,7 +120,7 @@ func buildMCPStartCmd() *cobra.Command {
120120
Short: "Start the Tiger MCP server",
121121
Long: `Start the Tiger Model Context Protocol (MCP) server for AI assistant integration.
122122
123-
The MCP server provides programmatic access to TigerData Cloud Platform resources
123+
The MCP server provides programmatic access to Tiger Cloud platform resources
124124
through Claude and other AI assistants. By default, it uses stdio transport.
125125
126126
Examples:

internal/tiger/cmd/mcp_install.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -209,16 +209,16 @@ func installMCPForClient(clientName string, createBackup bool, customConfigPath
209209

210210
fmt.Printf("\n💡 Next steps:\n")
211211
fmt.Printf(" 1. Restart %s to load the new configuration\n", clientName)
212-
fmt.Printf(" 2. The TigerData MCP server will be available as '%s'\n", mcp.ServerName)
212+
fmt.Printf(" 2. The Tiger MCP server will be available as '%s'\n", mcp.ServerName)
213213
fmt.Printf("\n🤖 Try asking your AI assistant:\n")
214-
fmt.Printf("\n 📊 List and manage your TigerData services:\n")
215-
fmt.Printf(" • \"List my TigerData services\"\n")
214+
fmt.Printf("\n 📊 List and manage your Tiger Cloud services:\n")
215+
fmt.Printf(" • \"List my Tiger Cloud services\"\n")
216216
fmt.Printf(" • \"Show me details for service xyz-123\"\n")
217217
fmt.Printf(" • \"Create a new database service called my-app-db\"\n")
218218
fmt.Printf(" • \"Update the password for my database service\"\n")
219-
fmt.Printf(" • \"What TigerData services do I have access to?\"\n")
220-
fmt.Printf("\n 📚 Ask questions from the PostgreSQL and TigerData documentation:\n")
221-
fmt.Printf(" • \"Show me TigerData documentation about hypertables?\"\n")
219+
fmt.Printf(" • \"What Tiger Cloud services do I have access to?\"\n")
220+
fmt.Printf("\n 📚 Ask questions from the PostgreSQL and Tiger Cloud documentation:\n")
221+
fmt.Printf(" • \"Show me Tiger Cloud documentation about hypertables?\"\n")
222222
fmt.Printf(" • \"What are the best practices for PostgreSQL indexing?\"\n")
223223
fmt.Printf(" • \"What is the command for renaming a table?\"\n")
224224
fmt.Printf(" • \"Help me optimize my PostgreSQL queries\"\n")

internal/tiger/cmd/root.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ func buildRootCmd(ctx context.Context) (*cobra.Command, error) {
2727

2828
cmd := &cobra.Command{
2929
Use: "tiger",
30-
Short: "Tiger CLI - TigerData Cloud Platform command-line interface",
31-
Long: `Tiger CLI is a command-line interface for managing TigerData Cloud Platform resources.
30+
Short: "Tiger CLI - Tiger Cloud Platform command-line interface",
31+
Long: `Tiger CLI is a command-line interface for managing Tiger Cloud platform resources.
3232
Built as a single Go binary, it provides comprehensive tools for managing database services,
3333
VPCs, replicas, and related infrastructure components.
3434

internal/tiger/cmd/service.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ func buildServiceCmd() *cobra.Command {
3131
Use: "service",
3232
Aliases: []string{"services", "svc"},
3333
Short: "Manage database services",
34-
Long: `Manage database services within TigerData Cloud Platform.`,
34+
Long: `Manage database services within Tiger Cloud platform.`,
3535
}
3636

3737
// Add all subcommands

internal/tiger/mcp/db_tools.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ func (s *Server) registerDatabaseTools() {
9797
Title: "Execute SQL Query",
9898
Description: `Execute a single SQL query against a service database.
9999
100-
This tool connects to a PostgreSQL database service in TigerData Cloud and executes the provided SQL query, returning the results with column names, row data, and execution metadata. Multi-statement queries are not supported.
100+
This tool connects to a PostgreSQL database service in Tiger Cloud and executes the provided SQL query, returning the results with column names, row data, and execution metadata. Multi-statement queries are not supported.
101101
102102
WARNING: Use with caution - this tool can execute any SQL statement including INSERT, UPDATE, DELETE, and DDL commands. Always review queries before execution.`,
103103
InputSchema: DBExecuteQueryInput{}.Schema(),

0 commit comments

Comments
 (0)