Skip to content

Commit 0175fef

Browse files
committed
add shls_coding_assistant plugin and marketplace
1 parent 0b0d36d commit 0175fef

23 files changed

Lines changed: 19332 additions & 0 deletions

.claude-plugin/marketplace.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"name": "mchp_hls_marketplace",
3+
"owner": {
4+
"name": "Microchip Technology",
5+
"email": "smartHLS@microchip.com"
6+
},
7+
"plugins": [
8+
{
9+
"name": "shls_coding_assistant",
10+
"source": "./shls-assistant/shls_plugin",
11+
"description": "MCP server and coding assistant for SmartHLS projects"
12+
}
13+
]
14+
}
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Additional information
2+
3+
## Understanding the `shls-mcp` Server
4+
5+
**Model Context Protocol (MCP)** is a communication protocol that allows AI models like Claude to interact with external tools, databases, and services. In this project, MCP enables Claude to:
6+
7+
- Access SmartHLS documentation in real-time
8+
- Run SmartHLS commands and tools
9+
- Retrieve context-specific information about FPGA development
10+
- Provide intelligent code generation based on best practices
11+
12+
### Components of the `shls-mcp` Server
13+
14+
#### 1.RAG (Retrieval-Augmented Generation)
15+
16+
The `shls-mcp` server uses RAG to provide context-aware assistance:
17+
18+
- **Document Store:** Contains comprehensive SmartHLS documentation, user guides, and examples
19+
- **Vector Database:** Stores document embeddings for efficient semantic search
20+
- **Query Engine:** Retrieves relevant documentation snippets based on your questions
21+
22+
#### 2. IBM Granite Embedding Model
23+
24+
The system uses IBM's Granite embedding model to:
25+
26+
- Convert SmartHLS documentation into vector embeddings
27+
- Perform semantic similarity searches
28+
- Match your queries with the most relevant documentation

0 commit comments

Comments
 (0)