Skip to content

Commit 002ea0c

Browse files
fix(docs): use "collections" consistently instead of "cores" (#51)
Replace references to "cores" with "collections" in CollectionService javadoc so AI agents see consistent terminology when interacting with MCP tool descriptions. --------- Signed-off-by: adityamparikh <aditya.m.parikh@gmail.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent ba020ed commit 002ea0c

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

src/main/java/org/apache/solr/mcp/server/metadata/CollectionService.java

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@
6565
* <strong>Core Capabilities:</strong>
6666
*
6767
* <ul>
68-
* <li><strong>Collection Discovery</strong>: Lists available collections/cores
69-
* with automatic SolrCloud vs standalone detection
68+
* <li><strong>Collection Discovery</strong>: Lists available collections with
69+
* automatic SolrCloud vs standalone detection
7070
* <li><strong>Performance Monitoring</strong>: Comprehensive metrics collection
7171
* including index, query, cache, and handler statistics
7272
* <li><strong>Health Monitoring</strong>: Real-time health checks with
@@ -304,7 +304,7 @@ public List<String> completeCollectionForSchema() {
304304
}
305305

306306
/**
307-
* Lists all available Solr collections or cores in the cluster.
307+
* Lists all available Solr collections in the cluster.
308308
*
309309
* <p>
310310
* This method automatically detects the Solr deployment type and uses the
@@ -313,7 +313,8 @@ public List<String> completeCollectionForSchema() {
313313
* <ul>
314314
* <li><strong>SolrCloud</strong>: Uses Collections API to list distributed
315315
* collections
316-
* <li><strong>Standalone</strong>: Uses Core Admin API to list individual cores
316+
* <li><strong>Standalone</strong>: Uses Core Admin API to list individual
317+
* collections
317318
* </ul>
318319
*
319320
* <p>
@@ -337,8 +338,8 @@ public List<String> completeCollectionForSchema() {
337338
* natural language requests like "list all collections" or "show me available
338339
* databases".
339340
*
340-
* @return a list of collection/core names, or an empty list if unable to
341-
* retrieve them
341+
* @return a list of collection names, or an empty list if unable to retrieve
342+
* them
342343
* @see CollectionAdminRequest.List
343344
* @see CoreAdminRequest
344345
*/
@@ -366,7 +367,7 @@ public List<String> listCollections() {
366367
}
367368
return cores;
368369
}
369-
} catch (SolrServerException | IOException e) {
370+
} catch (SolrServerException | IOException _) {
370371
return new ArrayList<>();
371372
}
372373
}
@@ -609,7 +610,7 @@ public CacheStats getCacheMetrics(String collection) {
609610
}
610611

611612
return stats;
612-
} catch (SolrServerException | IOException e) {
613+
} catch (SolrServerException | IOException _) {
613614
return null; // Return null instead of empty object
614615
}
615616
}
@@ -781,7 +782,7 @@ public HandlerStats getHandlerMetrics(String collection) {
781782
}
782783

783784
return stats;
784-
} catch (SolrServerException | IOException e) {
785+
} catch (SolrServerException | IOException _) {
785786
return null; // Return null instead of empty object
786787
}
787788
}
@@ -937,7 +938,8 @@ String extractCollectionName(String collectionOrShard) {
937938
*
938939
* <p>
939940
* This dual approach ensures compatibility with both standalone Solr (which
940-
* returns core names directly) and SolrCloud (which may return shard names).
941+
* returns collection names directly) and SolrCloud (which may return shard
942+
* names).
941943
*
942944
* <p>
943945
* <strong>Error Handling:</strong>
@@ -965,10 +967,8 @@ private boolean validateCollectionExists(String collection) {
965967
// Check if any of the returned collections start with the collection name (for
966968
// shard
967969
// names)
968-
boolean shardMatch = collections.stream().anyMatch(c -> c.startsWith(collection + SHARD_SUFFIX));
969-
970-
return shardMatch;
971-
} catch (Exception e) {
970+
return collections.stream().anyMatch(c -> c.startsWith(collection + SHARD_SUFFIX));
971+
} catch (Exception _) {
972972
return false;
973973
}
974974
}

0 commit comments

Comments
 (0)