Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| list_databases | List all databases in the Mochow instance.
Returns:
str: A string containing the names of all databases. |
| create_database | Create a database in the Mochow instance.
Args:
database_name (str): Name of the database.
Returns:
str: A message indicating the success of database creation. |
| use_database | Switch to a different database.
Args:
database_name (str): Name of the database to use.
Returns:
str: A message indicating the success of the database switch. |
| list_tables | List all tables in the current database.
Returns:
str: A string containing the names of all tables. |
| describe_table | Describe table details in the Mochow instance.
Args:
table_name (str): Name of the table to describe.
Returns:
str: A string containing the details of the table. |
| stats_table | Get the table statistics in the Mochow instance.
Args:
table_name (str): Name of the table to get statistics.
Returns:
str: A string containing the table statistics. |
| create_vector_index | Create a vector index on a vector type field in the Mochow instance.
Args:
table_name (str): Name of the table.
index_name (str): Name of the index.
field_name (str): Name of the vector field.
index_type (str): Type of vector index. Supported values are "HNSW", "HNSWPQ", "HNSWSQ".
metric_type (str): Distance metric. Supported values are "L2", "COSINE", "IP".
params (Optional[dict[str, Any]]): Additional vector index parameters.
Returns:
str: A message indicating the success of index creation. |
| describe_index | Describe index details in the Mochow instance.
Args:
table_name (str): Name of the table.
index_name (str): Name of the index to describe.
Returns:
str: A string containing the details of the index. |
| rebuild_vector_index | Rebuild the vector index in the Mochow instance.
Args:
table_name (str): Name of the table.
index_name (str): Name of the vector index to rebuild.
Returns:
str: A message indicating the success of index rebuild initiation. |
| delete_table_rows | Delete rows with a filter expression in the Mochow instance.
Args:
table_name (str): Name of the table.
filter_expr (str): Filter expression to select data to delete.
Returns:
str: A message indicating the success of data deletion. |
| drop_vector_index | Drop the vector index in the Mochow instance.
Args:
table_name (str): Name of the table.
index_name (str): Name of the vector index to drop.
Returns:
str: A message indicating the success of index drop. |
| select_table_rows | Select rows with a filter expression in the Mochow instance.
Args:
table_name (str): Name of the table.
filter_expr (str): Filter expression to select data. Defaults to None.
limit (int): Maximum number of results. Defaults to 10.
output_fields (Optional[list[str]]): Fields to return in the results. Defaults to None.
Returns:
str: A string containing the selected rows. |
| vector_search | Perform vector similarity search combining vector similarity and scalar attribute filtering in the Mochow instance.
Args:
table_name (str): Name of the table to search.
vector (list[float]): Search vector.
vector_field (str): Target field containing vectors to search. Defaults to "vector".
limit (int): Maximum number of results. Defaults to 10.
output_fields (Optional[list[str]]): Fields to return in the results. Defaults to None.
filter_expr (Optional[str]): Filter expression for scalar attributes. Defaults to None.
params: Additional vector search parameters
Returns:
str: A string containing the vector search results. |
| fulltext_search | Perform full text search combining BM25 similarity and scalar attribute filtering in the Mochow instance.
Args:
table_name (str): Name of the table to search.
index_name (str): Name of the inverted index to perform full text search.
search_text (str): Text to search.
limit (int): Maximum number of results. Defaults to 10.
output_fields (Optional[list[str]]): Fields to return in the results. Defaults to None.
Returns:
str: A string containing the full text search results. |