summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authoradamdottv <[email protected]>2025-05-14 14:25:09 -0500
committeradamdottv <[email protected]>2025-05-14 14:25:15 -0500
commit45c778b90d2e13cbdb54b07372fede413e430055 (patch)
treeba66523644a53c8ddc4578bd8b1ed7c322fa5524
parent47cbb650a0756133f794a93bd46ea79420512674 (diff)
downloadopencode-45c778b90d2e13cbdb54b07372fede413e430055.tar.gz
opencode-45c778b90d2e13cbdb54b07372fede413e430055.zip
feat: definition and references tools
-rw-r--r--internal/llm/agent/tools.go5
-rw-r--r--internal/llm/tools/definition.go198
-rw-r--r--internal/llm/tools/references.go161
3 files changed, 363 insertions, 1 deletions
diff --git a/internal/llm/agent/tools.go b/internal/llm/agent/tools.go
index 9551e32c5..b27ecc245 100644
--- a/internal/llm/agent/tools.go
+++ b/internal/llm/agent/tools.go
@@ -19,7 +19,6 @@ func PrimaryAgentTools(
lspClients map[string]*lsp.Client,
) []tools.BaseTool {
ctx := context.Background()
-
mcpTools := GetMcpTools(ctx, permissions)
return append(
@@ -34,6 +33,8 @@ func PrimaryAgentTools(
tools.NewPatchTool(lspClients, permissions, history),
tools.NewWriteTool(lspClients, permissions, history),
tools.NewDiagnosticsTool(lspClients),
+ tools.NewDefinitionTool(lspClients),
+ tools.NewReferencesTool(lspClients),
NewAgentTool(sessions, messages, lspClients),
}, mcpTools...,
)
@@ -45,5 +46,7 @@ func TaskAgentTools(lspClients map[string]*lsp.Client) []tools.BaseTool {
tools.NewGrepTool(),
tools.NewLsTool(),
tools.NewViewTool(lspClients),
+ tools.NewDefinitionTool(lspClients),
+ tools.NewReferencesTool(lspClients),
}
}
diff --git a/internal/llm/tools/definition.go b/internal/llm/tools/definition.go
new file mode 100644
index 000000000..e7dc50425
--- /dev/null
+++ b/internal/llm/tools/definition.go
@@ -0,0 +1,198 @@
+package tools
+
+import (
+ "context"
+ "encoding/json"
+ "fmt"
+ "log/slog"
+ "strings"
+
+ "github.com/sst/opencode/internal/lsp"
+ "github.com/sst/opencode/internal/lsp/protocol"
+)
+
+type DefinitionParams struct {
+ FilePath string `json:"file_path"`
+ Line int `json:"line"`
+ Column int `json:"column"`
+}
+
+type definitionTool struct {
+ lspClients map[string]*lsp.Client
+}
+
+const (
+ DefinitionToolName = "definition"
+ definitionDescription = `Find the definition of a symbol at a specific position in a file.
+WHEN TO USE THIS TOOL:
+- Use when you need to find where a symbol is defined
+- Helpful for understanding code structure and relationships
+- Great for navigating between implementation and interface
+
+HOW TO USE:
+- Provide the path to the file containing the symbol
+- Specify the line number (1-based) where the symbol appears
+- Specify the column number (1-based) where the symbol appears
+- Results show the location of the symbol's definition
+
+FEATURES:
+- Finds definitions across files in the project
+- Works with variables, functions, classes, interfaces, etc.
+- Returns file path, line, and column of the definition
+
+LIMITATIONS:
+- Requires a functioning LSP server for the file type
+- May not work for all symbols depending on LSP capabilities
+- Results depend on the accuracy of the LSP server
+
+TIPS:
+- Use in conjunction with References tool to understand usage
+- Combine with View tool to examine the definition
+`
+)
+
+func NewDefinitionTool(lspClients map[string]*lsp.Client) BaseTool {
+ return &definitionTool{
+ lspClients,
+ }
+}
+
+func (b *definitionTool) Info() ToolInfo {
+ return ToolInfo{
+ Name: DefinitionToolName,
+ Description: definitionDescription,
+ Parameters: map[string]any{
+ "file_path": map[string]any{
+ "type": "string",
+ "description": "The path to the file containing the symbol",
+ },
+ "line": map[string]any{
+ "type": "integer",
+ "description": "The line number (1-based) where the symbol appears",
+ },
+ "column": map[string]any{
+ "type": "integer",
+ "description": "The column number (1-based) where the symbol appears",
+ },
+ },
+ Required: []string{"file_path", "line", "column"},
+ }
+}
+
+func (b *definitionTool) Run(ctx context.Context, call ToolCall) (ToolResponse, error) {
+ var params DefinitionParams
+ if err := json.Unmarshal([]byte(call.Input), &params); err != nil {
+ return NewTextErrorResponse(fmt.Sprintf("error parsing parameters: %s", err)), nil
+ }
+
+ lsps := b.lspClients
+
+ if len(lsps) == 0 {
+ return NewTextResponse("\nLSP clients are still initializing. Definition lookup will be available once they're ready.\n"), nil
+ }
+
+ // Ensure file is open in LSP
+ notifyLspOpenFile(ctx, params.FilePath, lsps)
+
+ // Convert 1-based line/column to 0-based for LSP protocol
+ line := max(0, params.Line-1)
+ column := max(0, params.Column-1)
+
+ output := getDefinition(ctx, params.FilePath, line, column, lsps)
+
+ return NewTextResponse(output), nil
+}
+
+func getDefinition(ctx context.Context, filePath string, line, column int, lsps map[string]*lsp.Client) string {
+ var results []string
+
+ slog.Debug(fmt.Sprintf("Looking for definition in %s at line %d, column %d", filePath, line+1, column+1))
+ slog.Debug(fmt.Sprintf("Available LSP clients: %v", getClientNames(lsps)))
+
+ for lspName, client := range lsps {
+ slog.Debug(fmt.Sprintf("Trying LSP client: %s", lspName))
+ // Create definition params
+ uri := fmt.Sprintf("file://%s", filePath)
+ definitionParams := protocol.DefinitionParams{
+ TextDocumentPositionParams: protocol.TextDocumentPositionParams{
+ TextDocument: protocol.TextDocumentIdentifier{
+ URI: protocol.DocumentUri(uri),
+ },
+ Position: protocol.Position{
+ Line: uint32(line),
+ Character: uint32(column),
+ },
+ },
+ }
+ slog.Debug(fmt.Sprintf("Sending definition request with params: %+v", definitionParams))
+
+ // Get definition
+ definition, err := client.Definition(ctx, definitionParams)
+ if err != nil {
+ slog.Debug(fmt.Sprintf("Error from %s: %s", lspName, err))
+ results = append(results, fmt.Sprintf("Error from %s: %s", lspName, err))
+ continue
+ }
+ slog.Debug(fmt.Sprintf("Got definition result type: %T", definition.Value))
+
+ // Process the definition result
+ locations := processDefinitionResult(definition)
+ slog.Debug(fmt.Sprintf("Processed locations count: %d", len(locations)))
+ if len(locations) == 0 {
+ results = append(results, fmt.Sprintf("No definition found by %s", lspName))
+ continue
+ }
+
+ // Format the locations
+ for _, loc := range locations {
+ path := strings.TrimPrefix(string(loc.URI), "file://")
+ // Convert 0-based line/column to 1-based for display
+ defLine := loc.Range.Start.Line + 1
+ defColumn := loc.Range.Start.Character + 1
+ slog.Debug(fmt.Sprintf("Found definition at %s:%d:%d", path, defLine, defColumn))
+ results = append(results, fmt.Sprintf("Definition found by %s: %s:%d:%d", lspName, path, defLine, defColumn))
+ }
+ }
+
+ if len(results) == 0 {
+ return "No definition found for the symbol at the specified position."
+ }
+
+ return strings.Join(results, "\n")
+}
+
+func processDefinitionResult(result protocol.Or_Result_textDocument_definition) []protocol.Location {
+ var locations []protocol.Location
+
+ switch v := result.Value.(type) {
+ case protocol.Location:
+ locations = append(locations, v)
+ case []protocol.Location:
+ locations = append(locations, v...)
+ case []protocol.DefinitionLink:
+ for _, link := range v {
+ locations = append(locations, protocol.Location{
+ URI: link.TargetURI,
+ Range: link.TargetRange,
+ })
+ }
+ case protocol.Or_Definition:
+ switch d := v.Value.(type) {
+ case protocol.Location:
+ locations = append(locations, d)
+ case []protocol.Location:
+ locations = append(locations, d...)
+ }
+ }
+
+ return locations
+}
+
+// Helper function to get LSP client names for debugging
+func getClientNames(lsps map[string]*lsp.Client) []string {
+ names := make([]string, 0, len(lsps))
+ for name := range lsps {
+ names = append(names, name)
+ }
+ return names
+}
diff --git a/internal/llm/tools/references.go b/internal/llm/tools/references.go
new file mode 100644
index 000000000..6e0090f4e
--- /dev/null
+++ b/internal/llm/tools/references.go
@@ -0,0 +1,161 @@
+package tools
+
+import (
+ "context"
+ "encoding/json"
+ "fmt"
+ "strings"
+
+ "github.com/sst/opencode/internal/lsp"
+ "github.com/sst/opencode/internal/lsp/protocol"
+)
+
+type ReferencesParams struct {
+ FilePath string `json:"file_path"`
+ Line int `json:"line"`
+ Column int `json:"column"`
+ IncludeDeclaration bool `json:"include_declaration"`
+}
+
+type referencesTool struct {
+ lspClients map[string]*lsp.Client
+}
+
+const (
+ ReferencesToolName = "references"
+ referencesDescription = `Find all references to a symbol at a specific position in a file.
+WHEN TO USE THIS TOOL:
+- Use when you need to find all places where a symbol is used
+- Helpful for understanding code usage and dependencies
+- Great for refactoring and impact analysis
+
+HOW TO USE:
+- Provide the path to the file containing the symbol
+- Specify the line number (1-based) where the symbol appears
+- Specify the column number (1-based) where the symbol appears
+- Optionally set include_declaration to include the declaration in results
+- Results show all locations where the symbol is referenced
+
+FEATURES:
+- Finds references across files in the project
+- Works with variables, functions, classes, interfaces, etc.
+- Returns file paths, lines, and columns of all references
+
+LIMITATIONS:
+- Requires a functioning LSP server for the file type
+- May not find all references depending on LSP capabilities
+- Results depend on the accuracy of the LSP server
+
+TIPS:
+- Use in conjunction with Definition tool to understand symbol origins
+- Combine with View tool to examine the references
+`
+)
+
+func NewReferencesTool(lspClients map[string]*lsp.Client) BaseTool {
+ return &referencesTool{
+ lspClients,
+ }
+}
+
+func (b *referencesTool) Info() ToolInfo {
+ return ToolInfo{
+ Name: ReferencesToolName,
+ Description: referencesDescription,
+ Parameters: map[string]any{
+ "file_path": map[string]any{
+ "type": "string",
+ "description": "The path to the file containing the symbol",
+ },
+ "line": map[string]any{
+ "type": "integer",
+ "description": "The line number (1-based) where the symbol appears",
+ },
+ "column": map[string]any{
+ "type": "integer",
+ "description": "The column number (1-based) where the symbol appears",
+ },
+ "include_declaration": map[string]any{
+ "type": "boolean",
+ "description": "Whether to include the declaration in the results",
+ },
+ },
+ Required: []string{"file_path", "line", "column"},
+ }
+}
+
+func (b *referencesTool) Run(ctx context.Context, call ToolCall) (ToolResponse, error) {
+ var params ReferencesParams
+ if err := json.Unmarshal([]byte(call.Input), &params); err != nil {
+ return NewTextErrorResponse(fmt.Sprintf("error parsing parameters: %s", err)), nil
+ }
+
+ lsps := b.lspClients
+
+ if len(lsps) == 0 {
+ return NewTextResponse("\nLSP clients are still initializing. References lookup will be available once they're ready.\n"), nil
+ }
+
+ // Ensure file is open in LSP
+ notifyLspOpenFile(ctx, params.FilePath, lsps)
+
+ // Convert 1-based line/column to 0-based for LSP protocol
+ line := max(0, params.Line-1)
+ column := max(0, params.Column-1)
+
+ output := getReferences(ctx, params.FilePath, line, column, params.IncludeDeclaration, lsps)
+
+ return NewTextResponse(output), nil
+}
+
+func getReferences(ctx context.Context, filePath string, line, column int, includeDeclaration bool, lsps map[string]*lsp.Client) string {
+ var results []string
+
+ for lspName, client := range lsps {
+ // Create references params
+ uri := fmt.Sprintf("file://%s", filePath)
+ referencesParams := protocol.ReferenceParams{
+ TextDocumentPositionParams: protocol.TextDocumentPositionParams{
+ TextDocument: protocol.TextDocumentIdentifier{
+ URI: protocol.DocumentUri(uri),
+ },
+ Position: protocol.Position{
+ Line: uint32(line),
+ Character: uint32(column),
+ },
+ },
+ Context: protocol.ReferenceContext{
+ IncludeDeclaration: includeDeclaration,
+ },
+ }
+
+ // Get references
+ references, err := client.References(ctx, referencesParams)
+ if err != nil {
+ results = append(results, fmt.Sprintf("Error from %s: %s", lspName, err))
+ continue
+ }
+
+ if len(references) == 0 {
+ results = append(results, fmt.Sprintf("No references found by %s", lspName))
+ continue
+ }
+
+ // Format the locations
+ results = append(results, fmt.Sprintf("References found by %s:", lspName))
+ for _, loc := range references {
+ path := strings.TrimPrefix(string(loc.URI), "file://")
+ // Convert 0-based line/column to 1-based for display
+ refLine := loc.Range.Start.Line + 1
+ refColumn := loc.Range.Start.Character + 1
+ results = append(results, fmt.Sprintf(" %s:%d:%d", path, refLine, refColumn))
+ }
+ }
+
+ if len(results) == 0 {
+ return "No references found for the symbol at the specified position."
+ }
+
+ return strings.Join(results, "\n")
+}
+