Skip to content

Commit e11ea13

Browse files
jeanlaurentjeanlaurent
authored
Merge pull request #111 from dgageot/sync-READMEs
Sync the README files
2 parents 8cccd64 + 39b2694 commit e11ea13

Some content is hidden

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

71 files changed

+5747
-8192
lines changed

‎prompts/mcp/readmes/armor-crypto.md‎

Lines changed: 174 additions & 284 deletions
Large diffs are not rendered by default.

‎prompts/mcp/readmes/astra-db.md‎

Lines changed: 99 additions & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -4,170 +4,153 @@ An MCP server for Astra DB workloads
44

55
[What is an MCP Server?](https://www.anthropic.com/news/model-context-protocol)
66

7-
| <!-- --> | <!-- --> |
8-
|-----------|---------|
9-
| **Image Source** | Official Image |
10-
| **Author** | [datastax](https://github.com/datastax) |
11-
| **Repository** | https://github.com/datastax/astra-db-mcp |
12-
| **Dockerfile** | https://github.com/datastax/astra-db-mcp/blob/refs/pull/14/merge/Dockerfile |
13-
| **Docker Image built by** | Docker Inc. |
14-
| **Licence** | Apache License 2.0 |
15-
16-
## Tools Summary
17-
18-
1. **`BulkCreateRecords`**: Create multiple records in a collection at once
19-
1. **`BulkDeleteRecords`**: Delete multiple records from a collection at once
20-
1. **`BulkUpdateRecords`**: Update multiple records in a collection at once
21-
1. **`CreateCollection`**: Create a new collection in the database
22-
1. **`CreateRecord`**: Create a new record in a collection
23-
1. **`DeleteCollection`**: Delete a collection from the database
24-
1. **`DeleteRecord`**: Delete a record from a collection
25-
1. **`EstimateDocumentCount`**: Estimate the number of documents in a collection using a fast, approximate count method
26-
1. **`FindRecord`**: Find records in a collection by field value
27-
1. **`GetCollections`**: Get all collections in the Astra DB database
28-
1. **`GetRecord`**: Get a specific record from a collection by ID
29-
1. **`HelpAddToClient`**: Help the user add the Astra DB client to their MCP client
30-
1. **`ListRecords`**: List records from a collection in the database
31-
1. **`OpenBrowser`**: Open a web browser to a specific URL
32-
1. **`UpdateCollection`**: Update an existing collection in the database
33-
1. **`UpdateRecord`**: Update an existing record in a collection
7+
|<!-- -->|<!-- -->|
8+
|-|-|
9+
**Image Source**|Official Image
10+
|**Author**|[datastax](https://github.com/datastax)
11+
**Repository**|https://github.com/datastax/astra-db-mcp
12+
**Dockerfile**|https://github.com/datastax/astra-db-mcp/blob/refs/pull/14/merge/Dockerfile
13+
**Docker Image built by**|Docker Inc.
14+
**Licence**|Apache License 2.0
15+
16+
## Summary
17+
1. `BulkCreateRecords` Create multiple records in a collection at once
18+
1. `BulkDeleteRecords` Delete multiple records from a collection at once
19+
1. `BulkUpdateRecords` Update multiple records in a collection at once
20+
1. `CreateCollection` Create a new collection in the database
21+
1. `CreateRecord` Create a new record in a collection
22+
1. `DeleteCollection` Delete a collection from the database
23+
1. `DeleteRecord` Delete a record from a collection
24+
1. `EstimateDocumentCount` Estimate the number of documents in a collection using a fast, approximate count method
25+
1. `FindRecord` Find records in a collection by field value
26+
1. `GetCollections` Get all collections in the Astra DB database
27+
1. `GetRecord` Get a specific record from a collection by ID
28+
1. `HelpAddToClient` Help the user add the Astra DB client to their MCP client
29+
1. `ListRecords` List records from a collection in the database
30+
1. `OpenBrowser` Open a web browser to a specific URL
31+
1. `UpdateCollection` Update an existing collection in the database
32+
1. `UpdateRecord` Update an existing record in a collection
3433

3534
## Tools
3635

37-
### Tool: **`BulkCreateRecords`**
38-
36+
### Tool `BulkCreateRecords`
3937
Create multiple records in a collection at once
4038

41-
| Parameter | Type | Description |
42-
| - | - | - |
43-
| `collectionName` | `string` | Name of the collection to create the records in |
44-
| `records` | `array` | Array of records to insert |
45-
46-
### Tool: **`BulkDeleteRecords`**
39+
Parameter|Type|Description
40+
-|-|-
41+
`collectionName`|`string`|Name of the collection to create the records in
42+
`records`|`array`|Array of records to insert
4743

44+
### Tool `BulkDeleteRecords`
4845
Delete multiple records from a collection at once
4946

50-
| Parameter | Type | Description |
51-
| - | - | - |
52-
| `collectionName` | `string` | Name of the collection containing the records |
53-
| `recordIds` | `array` | Array of record IDs to delete |
54-
55-
### Tool: **`BulkUpdateRecords`**
47+
Parameter|Type|Description
48+
-|-|-
49+
`collectionName`|`string`|Name of the collection containing the records
50+
`recordIds`|`array`|Array of record IDs to delete
5651

52+
### Tool `BulkUpdateRecords`
5753
Update multiple records in a collection at once
5854

59-
| Parameter | Type | Description |
60-
| - | - | - |
61-
| `collectionName` | `string` | Name of the collection containing the records |
62-
| `records` | `array` | Array of records to update with their IDs |
63-
64-
### Tool: **`CreateCollection`**
55+
Parameter|Type|Description
56+
-|-|-
57+
`collectionName`|`string`|Name of the collection containing the records
58+
`records`|`array`|Array of records to update with their IDs
6559

60+
### Tool `CreateCollection`
6661
Create a new collection in the database
6762

68-
| Parameter | Type | Description |
69-
| - | - | - |
70-
| `collectionName` | `string` | Name of the collection to create |
71-
| `dimension` | `number` *optional* | The dimensions of the vector collection, if vector is true |
72-
| `vector` | `boolean` *optional* | Whether to create a vector collection |
73-
74-
### Tool: **`CreateRecord`**
63+
Parameter|Type|Description
64+
-|-|-
65+
`collectionName`|`string`|Name of the collection to create
66+
`dimension`|`number` *optional*|The dimensions of the vector collection, if vector is true
67+
`vector`|`boolean` *optional*|Whether to create a vector collection
7568

69+
### Tool `CreateRecord`
7670
Create a new record in a collection
7771

78-
| Parameter | Type | Description |
79-
| - | - | - |
80-
| `collectionName` | `string` | Name of the collection to create the record in |
81-
| `record` | `object` | The record data to insert |
82-
83-
### Tool: **`DeleteCollection`**
72+
Parameter|Type|Description
73+
-|-|-
74+
`collectionName`|`string`|Name of the collection to create the record in
75+
`record`|`object`|The record data to insert
8476

77+
### Tool `DeleteCollection`
8578
Delete a collection from the database
8679

87-
| Parameter | Type | Description |
88-
| - | - | - |
89-
| `collectionName` | `string` | Name of the collection to delete |
90-
91-
### Tool: **`DeleteRecord`**
80+
Parameter|Type|Description
81+
-|-|-
82+
`collectionName`|`string`|Name of the collection to delete
9283

84+
### Tool `DeleteRecord`
9385
Delete a record from a collection
9486

95-
| Parameter | Type | Description |
96-
| - | - | - |
97-
| `collectionName` | `string` | Name of the collection containing the record |
98-
| `recordId` | `string` | ID of the record to delete |
99-
100-
### Tool: **`EstimateDocumentCount`**
87+
Parameter|Type|Description
88+
-|-|-
89+
`collectionName`|`string`|Name of the collection containing the record
90+
`recordId`|`string`|ID of the record to delete
10191

92+
### Tool `EstimateDocumentCount`
10293
Estimate the number of documents in a collection using a fast, approximate count method
10394

104-
| Parameter | Type | Description |
105-
| - | - | - |
106-
| `collectionName` | `string` | Name of the collection to estimate document count for |
107-
108-
### Tool: **`FindRecord`**
95+
Parameter|Type|Description
96+
-|-|-
97+
`collectionName`|`string`|Name of the collection to estimate document count for
10998

99+
### Tool `FindRecord`
110100
Find records in a collection by field value
111101

112-
| Parameter | Type | Description |
113-
| - | - | - |
114-
| `collectionName` | `string` | Name of the collection to search in |
115-
| `field` | `string` | Field name to search by (e.g., 'title', '_id', or any property) |
116-
| `value` | `string` | Value to search for in the specified field |
117-
| `limit` | `number` *optional* | Maximum number of records to return |
118-
119-
### Tool: **`GetCollections`**
102+
Parameter|Type|Description
103+
-|-|-
104+
`collectionName`|`string`|Name of the collection to search in
105+
`field`|`string`|Field name to search by (e.g., 'title', '_id', or any property)
106+
`value`|`string`|Value to search for in the specified field
107+
`limit`|`number` *optional*|Maximum number of records to return
120108

109+
### Tool `GetCollections`
121110
Get all collections in the Astra DB database
122111

123-
### Tool: **`GetRecord`**
124-
112+
### Tool `GetRecord`
125113
Get a specific record from a collection by ID
126114

127-
| Parameter | Type | Description |
128-
| - | - | - |
129-
| `collectionName` | `string` | Name of the collection to get the record from |
130-
| `recordId` | `string` | ID of the record to retrieve |
131-
132-
### Tool: **`HelpAddToClient`**
115+
Parameter|Type|Description
116+
-|-|-
117+
`collectionName`|`string`|Name of the collection to get the record from
118+
`recordId`|`string`|ID of the record to retrieve
133119

120+
### Tool `HelpAddToClient`
134121
Help the user add the Astra DB client to their MCP client
135122

136-
### Tool: **`ListRecords`**
137-
123+
### Tool `ListRecords`
138124
List records from a collection in the database
139125

140-
| Parameter | Type | Description |
141-
| - | - | - |
142-
| `collectionName` | `string` | Name of the collection to list records from |
143-
| `limit` | `number` *optional* | Maximum number of records to return |
144-
145-
### Tool: **`OpenBrowser`**
126+
Parameter|Type|Description
127+
-|-|-
128+
`collectionName`|`string`|Name of the collection to list records from
129+
`limit`|`number` *optional*|Maximum number of records to return
146130

131+
### Tool `OpenBrowser`
147132
Open a web browser to a specific URL
148133

149-
| Parameter | Type | Description |
150-
| - | - | - |
151-
| `url` | `string` | The URL to open in the browser |
152-
153-
### Tool: **`UpdateCollection`**
134+
Parameter|Type|Description
135+
-|-|-
136+
`url`|`string`|The URL to open in the browser
154137

138+
### Tool `UpdateCollection`
155139
Update an existing collection in the database
156140

157-
| Parameter | Type | Description |
158-
| - | - | - |
159-
| `collectionName` | `string` | Name of the collection to update |
160-
| `newName` | `string` | New name for the collection |
161-
162-
### Tool: **`UpdateRecord`**
141+
Parameter|Type|Description
142+
-|-|-
143+
`collectionName`|`string`|Name of the collection to update
144+
`newName`|`string`|New name for the collection
163145

146+
### Tool `UpdateRecord`
164147
Update an existing record in a collection
165148

166-
| Parameter | Type | Description |
167-
| - | - | - |
168-
| `collectionName` | `string` | Name of the collection containing the record |
169-
| `record` | `object` | The updated record data |
170-
| `recordId` | `string` | ID of the record to update |
149+
Parameter|Type|Description
150+
-|-|-
151+
`collectionName`|`string`|Name of the collection containing the record
152+
`record`|`object`|The updated record data
153+
`recordId`|`string`|ID of the record to update
171154

172155
## Use this MCP Server
173156

@@ -196,10 +179,3 @@ Update an existing record in a collection
196179
```
197180

198181
[Why is it safer to run MCP Servers with Docker?](https://www.docker.com/blog/the-model-context-protocol-simplifying-building-ai-apps-with-anthropic-claude-desktop-and-docker/)
199-
200-
## Rebuild this image
201-
202-
```console
203-
docker build -t mcp/astra-db -f Dockerfile https://github.com/datastax/astra-db-mcp.git#refs/pull/14/merge
204-
```
205-

‎prompts/mcp/readmes/atlas-docs.md‎

Lines changed: 34 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -4,62 +4,56 @@ Provide LLMs hosted, clean markdown documentation of libraries and frameworks
44

55
[What is an MCP Server?](https://www.anthropic.com/news/model-context-protocol)
66

7-
| <!-- --> | <!-- --> |
8-
|-----------|---------|
9-
| **Image Source** | Official Image |
10-
| **Author** | [CartographAI](https://github.com/CartographAI) |
11-
| **Repository** | https://github.com/CartographAI/atlas-docs-mcp |
12-
| **Dockerfile** | https://github.com/CartographAI/atlas-docs-mcp/blob/master/Dockerfile |
13-
| **Docker Image built by** | Docker Inc. |
14-
| **Licence** | MIT License |
15-
16-
## Tools Summary
17-
18-
1. **`get_docs_full`**: Retrieves the complete documentation content in a single consolidated file. Use this when you need comprehensive knowledge or need to analyze the full documentation context. Returns a large volume of text - consider using get_docs_page or search_docs for targeted information.
19-
1. **`get_docs_index`**: Retrieves a condensed, LLM-friendly index of the pages in a documentation set. Use this for initial exploration to understand what's covered and identify relevant pages. Returns a markdown page with a list of available pages. Follow up with get_docs_page to get full content.
20-
1. **`get_docs_page`**: Retrieves a specific documentation page's content using its relative path. Use this to get detailed information about a known topic, after identifying the relevant page through get_docs_index or search_docs. Returns the complete content of a single documentation page.
21-
1. **`list_docs`**: Lists all available documentation libraries and frameworks. Use this as your first step to discover available documentation sets. Returns name, description and source url for each documentation set. Required before using other documentation tools since you need the docName.
22-
1. **`search_docs`**: Searches a documentation set for specific content. Use this to find pages containing particular keywords, concepts, or topics. Returns matching pages ranked by relevance with their paths and descriptions. Follow up with get_docs_page to get full content.
7+
|<!-- -->|<!-- -->|
8+
|-|-|
9+
**Image Source**|Official Image
10+
|**Author**|[CartographAI](https://github.com/CartographAI)
11+
**Repository**|https://github.com/CartographAI/atlas-docs-mcp
12+
**Dockerfile**|https://github.com/CartographAI/atlas-docs-mcp/blob/master/Dockerfile
13+
**Docker Image built by**|Docker Inc.
14+
**Licence**|MIT License
15+
16+
## Summary
17+
1. `get_docs_full` Retrieves the complete documentation content in a single consolidated file.
18+
1. `get_docs_index` Retrieves a condensed, LLM-friendly index of the pages in a documentation set.
19+
1. `get_docs_page` Retrieves a specific documentation page's content using its relative path.
20+
1. `list_docs` Lists all available documentation libraries and frameworks.
21+
1. `search_docs` Searches a documentation set for specific content.
2322

2423
## Tools
2524

26-
### Tool: **`get_docs_full`**
27-
25+
### Tool `get_docs_full`
2826
Retrieves the complete documentation content in a single consolidated file. Use this when you need comprehensive knowledge or need to analyze the full documentation context. Returns a large volume of text - consider using get_docs_page or search_docs for targeted information.
2927

30-
| Parameter | Type | Description |
31-
| - | - | - |
32-
| `docName` | `string` | Name of the documentation set |
33-
34-
### Tool: **`get_docs_index`**
28+
Parameter|Type|Description
29+
-|-|-
30+
`docName`|`string`|Name of the documentation set
3531

32+
### Tool `get_docs_index`
3633
Retrieves a condensed, LLM-friendly index of the pages in a documentation set. Use this for initial exploration to understand what's covered and identify relevant pages. Returns a markdown page with a list of available pages. Follow up with get_docs_page to get full content.
3734

38-
| Parameter | Type | Description |
39-
| - | - | - |
40-
| `docName` | `string` | Name of the documentation set |
41-
42-
### Tool: **`get_docs_page`**
35+
Parameter|Type|Description
36+
-|-|-
37+
`docName`|`string`|Name of the documentation set
4338

39+
### Tool `get_docs_page`
4440
Retrieves a specific documentation page's content using its relative path. Use this to get detailed information about a known topic, after identifying the relevant page through get_docs_index or search_docs. Returns the complete content of a single documentation page.
4541

46-
| Parameter | Type | Description |
47-
| - | - | - |
48-
| `docName` | `string` | Name of the documentation set |
49-
| `pagePath` | `string` | The root-relative path of the specific documentation page (e.g., '/guides/getting-started', '/api/authentication') |
50-
51-
### Tool: **`list_docs`**
42+
Parameter|Type|Description
43+
-|-|-
44+
`docName`|`string`|Name of the documentation set
45+
`pagePath`|`string`|The root-relative path of the specific documentation page (e.g., '/guides/getting-started', '/api/authentication')
5246

47+
### Tool `list_docs`
5348
Lists all available documentation libraries and frameworks. Use this as your first step to discover available documentation sets. Returns name, description and source url for each documentation set. Required before using other documentation tools since you need the docName.
5449

55-
### Tool: **`search_docs`**
56-
50+
### Tool `search_docs`
5751
Searches a documentation set for specific content. Use this to find pages containing particular keywords, concepts, or topics. Returns matching pages ranked by relevance with their paths and descriptions. Follow up with get_docs_page to get full content.
5852

59-
| Parameter | Type | Description |
60-
| - | - | - |
61-
| `docName` | `string` | Name of the documentation set |
62-
| `query` | `string` | Search query to find relevant pages within the documentation set |
53+
Parameter|Type|Description
54+
-|-|-
55+
`docName`|`string`|Name of the documentation set
56+
`query`|`string`|Search query to find relevant pages within the documentation set
6357

6458
## Use this MCP Server
6559

@@ -85,10 +79,3 @@ Searches a documentation set for specific content. Use this to find pages contai
8579
```
8680

8781
[Why is it safer to run MCP Servers with Docker?](https://www.docker.com/blog/the-model-context-protocol-simplifying-building-ai-apps-with-anthropic-claude-desktop-and-docker/)
88-
89-
## Rebuild this image
90-
91-
```console
92-
docker build -t mcp/atlas-docs -f Dockerfile https://github.com/CartographAI/atlas-docs-mcp.git#master
93-
```
94-

0 commit comments

Comments
 (0)